class rtddCallback

Class for rtdd callback.

Inheritance:

Public Fields

string

chnname channel name

Public Methods

explicit	rtddCallback (const string& Chnname) Constructor.
virtual	~rtddCallback () Destructor.
	rtddCallback (const rtddCallback& rtddcb) Copy constructor.
rtddCallback&	operator= (const rtddCallback& rtddcb) Copy constructor.
bool	operator== (const rtddCallback& rtddchn) const Equality operator.
bool	operator== (const string& name) const Equality operator.
bool	operator!= (const rtddCallback& rtddchn) const Inequality operator.
bool	operator!= (const string& name) const Inequality operator.
bool	operator< (const rtddCallback& rtddchn) const Equality operator.
bool	subscribe (tainsec_t start = 0, tainsec_t* active = 0) Subscribe method.
bool	unsubscribe () Subscribe method.
bool	isSet () const isSet operator.
virtual int	callback (taisec_t time, int epoch, float data[], int ndata, int err) Callback method.

Protected Fields

mutable recursivemutex

mux mutex to protect object

explicit rtddCallback(const string& Chnname)

Constructs an channel callback object.

Returns:

void

Parameters:

chnname - channel name

virtual ~rtddCallback()

Destructs the channel callback object.

Returns:

void

rtddCallback(const rtddCallback& rtddcb)

Constructs an channel callback object.

Returns:

void

Parameters:

rtddcb - channel callback object

rtddCallback& operator= (const rtddCallback& rtddcb)

Constructs an channel callback object.

Returns:

void

Parameters:

rtddcb - channel callback object

bool operator== (const rtddCallback& rtddchn) const

Compares two channel object by their name.

Returns:

true if equal

bool operator== (const string& name) const

Compares two channel object by their name.

Returns:

true if equal

bool operator!= (const rtddCallback& rtddchn) const

Compares two channel object by their name.

Returns:

true if not equal

bool operator!= (const string& name) const

Compares two channel object by their name.

Returns:

true if not equal

bool operator< (const rtddCallback& rtddchn) const

Compares two channel object by their name.

Returns:

true if equal

bool subscribe(tainsec_t start = 0, tainsec_t* active = 0)

Subsrcibe to real-time data distribution.

Returns:

true if successful

Parameters:

start - time when channels are needed
active - time when channels become available

bool unsubscribe()

Subsrcibe to real-time data distribution.

Returns:

true if successful

Parameters:

start - time when channels are needed
active - time when channels become available

bool isSet() const

Checks if channel callback was successfully setup.

Returns:

true if channel subscription failed

virtual int callback(taisec_t time, int epoch, float data[], int ndata, int err)

Callback method for channel data. This method is called by the RTDD every time new channel data is avaialble. This is a pure virtual function and has to be overwritten by a descendent class. This function should return 0, in order to continue to receive data.

Returns:

0 to continue

Parameters:

time - time of first data point (sec)
epoch - epoch of first data point
data - array of data points
ndata - number of data points
err - error code indicating invalid or missing data

string chnname

channel name

mutable recursivemutex mux

mutex to protect object

Direct child classes:

rtddChannel

Author:

DS, November 98

See Also:

Real-time data distribution input API

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++