class MonIndex

Access monitor index information.

Inheritance:

Public Fields

typedef IndexMap::const_iterator

const_index_iterator Iterator.

Public Methods

	MonIndex (void) Default constructor.
	MonIndex (MonClient& mc) Construct an index and fill it from the specified client
	MonIndex (const char* Server) Construct an index and initialize it from the specified server
	~MonIndex (void) Destroy an index
const_index_iterator	begin (void) const Index start iterator.
const_index_iterator	end (void) const Index end iterator.
const_index_iterator	find (const std::string& Name) const Get pointer to specified entry.
bool	exists (const std::string& name) const Test whether the specified entry exists
const char*	getComment (const std::string& name) const Get the specified comment.
const char*	getComment (const_index_iterator& iter) const Get the specified comment.
const char*	getName (const_index_iterator& iter) const Get the name from the entry pointed to by an iterator
const char*	getType (const std::string& name) const Get the type field from the named entry
const char*	getType (const_index_iterator& iter) const Get the type field from the named entry
bool	setIndex (MonClient& mc) Get index information.
bool	setIndex (const char* Server) Get index information.
void	clear (void) Remove all entries from the index

typedef IndexMap::const_iterator const_index_iterator

The index iterator may be used to iterate over all entries in the index. The first and last legal values for the iterator are given by begin() and end(), respectively, and the iterator corresponding to a given entry may be fetched with find(). const_index_iterator has all te properties of a standard template library iterator.

MonIndex(void)

Construct an empty index.

MonIndex(MonClient& mc)

Construct an index and fill it from the specified client

MonIndex(const char* Server)

Construct an index and initialize it from the specified server

~MonIndex(void)

Destroy an index

const_index_iterator begin(void) const

Return a pointer to first entry in the index.

Returns:

iterator pointing to the first entry in the Index.

const_index_iterator end(void) const

Return a pointer to last entry in the index.

Returns:

iterator pointing to the last entry in the Index.

const_index_iterator find(const std::string& Name) const

Return a pointer to named entry in the index.

Returns:

iterator pointing to the name entry in the Index.

bool exists(const std::string& name) const

Test whether the specified entry exists

const char* getComment(const std::string& name) const

Get the comment field from the named entry.

Returns:

Pointer to the named comment

const char* getComment(const_index_iterator& iter) const

Get the comment field from the named entry.

Returns:

Pointer to the named comment

const char* getName(const_index_iterator& iter) const

Get the name from the entry pointed to by an iterator

const char* getType(const std::string& name) const

Get the type field from the named entry

const char* getType(const_index_iterator& iter) const

Get the type field from the named entry

bool setIndex(MonClient& mc)

Add entries to an index. The specified client interface is used to access the index information from the connected server.

Returns:

true if successful

Parameters:

mc - A connected Client interface.

bool setIndex(const char* Server)

Add entries to an index. A temporary client interface is created and connected to the specified server. This is used to access the index information from the server.

Returns:

true if successful

Parameters:

Server - Pointer to a character string holding the server name.

void clear(void)

Remove all entries from the index

alphabetic index hierarchy of classes

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

generated by doc++