class MonClient : private lmsg AppClient

Monitor Data Client API.

Inheritance:

Public Methods

	MonClient (void) Construct a client
	MonClient (const char* Process) Construct a client and connect it to a server.
	~MonClient (void) Disconnect and delete the Client.
lmsg::error_type	setServer (const char* Server) Connect to a server.
lmsg::error_type	getData (const char* Name, long* ival) Get integer data.
lmsg::error_type	getData (const char* Name, double* dVal) Get float data.
lmsg::error_type	getData (const char* Name, std::string* sVal) Get character string data.
lmsg::error_type	getData (const char* Name, TSeries* ts) Get TSeries data.
lmsg::error_type	getData (const char* Name, FSeries* fs) Get FSeries data.
lmsg::error_type	getData (const char* Name, FSpectrum* fs) Get FSpectrum data.
lmsg::error_type	getData (const char* Name, Histogram1* hg) Get Histogram1 data.
lmsg::error_type	getIndex (std::string& sVal) List the data available from the server.
void	setDebug (lmsg::index_type level) Make AppClient methods public

Inherited from AppClient:

Public Methods

error_type request(const MsgAddr& to, const Message& req, MsgHeader& hdr, char* data, index_type length)

error_type request(const MsgHeader& ReqHdr, const void* ReqData, MsgHeader& hdr, char* data, index_type length)

error_type request(const MsgAddr& to, const Message& Req, Message& Reply)

error_type request(const MsgAddr& to, const Message& Req, MsgHeader& RepHdr, Message& Reply)

error_type getDebug(void) const

error_type getRetry(void) const

wtime_type getTimeOut(void) const

bool isOpen(void) const

void setBufferPool(BufferPool* pool)

void setRetry(index_type n)

void setTimeOut(wtime_type time)

void setSocketPool(SocketPool* pool)

MonClient(void)

Construct a client

MonClient(const char* Process)

Construct a client and connect it logically to the specified server process.

Parameters:

Process - Server process name the client will connect to.

~MonClient(void)

Destroy the client and release any ports currently in use by the client.

lmsg::error_type setServer(const char* Server)

Look up the address of the specified server. All subsequent data requests will be sent to the named server until another setSever() request is made.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Server - Name of server to which the client will

lmsg::error_type getData(const char* Name, long* ival)

Get an integer data word with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
iVal - pointer to the long word to receive the data.

lmsg::error_type getData(const char* Name, double* dVal)

Get a double precision floating point data item with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
dVal - pointer to the double float word to received the data.

lmsg::error_type getData(const char* Name, std::string* sVal)

Get a character string with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
sVal - pointer to a string into which the data will be stored.

lmsg::error_type getData(const char* Name, TSeries* ts)

Get a Time Series with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
ts - pointer to a TSeries into which the data will be stored.

lmsg::error_type getData(const char* Name, FSeries* fs)

Get a Frequency series with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
fs - Pointer to an FSeries into which the data will be stored.

lmsg::error_type getData(const char* Name, FSpectrum* fs)

Get a power spectrum with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
fs - Pointer to an FSeries into which the data will be stored.

lmsg::error_type getData(const char* Name, Histogram1* hg)

Get a 1-d histogram with the specified name.

Returns:

An error code from lmsg::ErrorList.

Parameters:

Name - Name of data value to be fetched from the server.
fs - Pointer to an Histogram1 into which the data will be stored.

lmsg::error_type getIndex(std::string& sVal)

Get the index of named data elements available from the current server. The index is returned as a single character string. The string contains one entry for each data element known to the server. Entries contain the data name (key), the data type and a comment string separated by semicolons (";"). The entries are in turn separated by new-line characters.

Returns:

An error code from lmsg::ErrorList.

Parameters:

sVal - pointer to the string to receive the index.

void setDebug(lmsg::index_type level)

Make AppClient methods public

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++