Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_SignalHolder Class Reference

Class to hold a CP_Signal1 object and CP_String used in storing signals in lists that can be retreived by a signal name. More...

List of all members.

Public Member Functions

 CP_SignalHolder ()
 CP_SignalHolder (const CP_String &inSignalName, CP_DataValueSignal *inSignal)
 CP_SignalHolder (const CP_SignalHolder &inSignalHolder)
 ~CP_SignalHolder ()
CP_SignalHolderoperator= (const CP_SignalHolder &inSignalHolder)
bool operator== (const CP_SignalHolder &inSignalHolder)
bool operator!= (const CP_SignalHolder &inSignalHolder)
CP_String GetSignalName () const
CP_DataValueSignalGetSignal ()

Protected Attributes

CP_String fSignalName
CP_DataValueSignalfSignal


Detailed Description

This class stores an association of a single CP_Signal1 and a string containing the name of the signal. Used in CP_Object to find and register signal handlers by name.


Constructor & Destructor Documentation

CP_SignalHolder::CP_SignalHolder  ) 
 

Constructor.

CP_SignalHolder::CP_SignalHolder const CP_String inSignalName,
CP_DataValueSignal inSignal
 

Constructor.

Parameters:
inSignalName String containing the name of the signal stored in inSignal.
inSignal CP_Signal1 object. This is a CP_Signal that takes a single CP_DataValue parameter.

CP_SignalHolder::CP_SignalHolder const CP_SignalHolder inSignalHolder  ) 
 

Copy constructor. Assigns the data fields from the passed in CP_SignalHolder.

Parameters:
inSignalHolder CP_SignalHolder to copy the data fields from.

CP_SignalHolder::~CP_SignalHolder  ) 
 

Destructor.


Member Function Documentation

CP_SignalHolder& CP_SignalHolder::operator= const CP_SignalHolder inSignalHolder  ) 
 

Assignment operator.

Parameters:
inSignalHolder CP_SignalHolder to copy the data fields from.
Returns:
CP_SignalHolder& Returns a reference to ourselves.

bool CP_SignalHolder::operator== const CP_SignalHolder inSignalHolder  ) 
 

Equality operator.

Parameters:
inSignalHolder CP_SignalHolder to test for equality.
Returns:
bool Returns true if this object is the same as the passed in CP_SignalHolder.

bool CP_SignalHolder::operator!= const CP_SignalHolder inSignalHolder  ) 
 

Inequality operator.

Parameters:
inSignalHolder CP_SignalHolder to test for inequality.
Returns:
bool Returns true if this object are not the same as the passed in CP_SignalHolder.

CP_String CP_SignalHolder::GetSignalName  )  const
 

Returns the name of the signal.

Returns:
CP_String const Returns the name of the signal as a CP_String.

CP_DataValueSignal* CP_SignalHolder::GetSignal  ) 
 

Returns the CP_Signal1 signal object

Returns:
CP_DataValueSignal * Returns a pointer to the CP_Signal1 object.


Member Data Documentation

CP_String CP_SignalHolder::fSignalName [protected]
 

CP_DataValueSignal* CP_SignalHolder::fSignal [protected]
 

CP_String containing the name of the signal.


The documentation for this class was generated from the following file:
Generated on Sat Sep 17 20:02:13 2005 for CPLAT by  doxygen 1.4.0