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

CP_SlotHolder Class Reference

Class to hold a CP_Slot1 object and CP_String used in storing slots in lists that can be retreived by a slot name. More...

List of all members.

Public Member Functions

 CP_SlotHolder ()
 CP_SlotHolder (const CP_String &inSlotName, CP_DataValueSlot inSlot)
 CP_SlotHolder (const CP_SlotHolder &inSlotHolder)
 ~CP_SlotHolder ()
CP_SlotHolderoperator= (const CP_SlotHolder &inSlotHolder)
bool operator== (const CP_SlotHolder &inSlotHolder)
bool operator!= (const CP_SlotHolder &inSlotHolder)
CP_String GetSlotName () const
CP_DataValueSlot GetSlot ()

Protected Attributes

CP_String fSlotName
CP_DataValueSlot fSlot


Detailed Description

This class stores an association of a single CP_Slot1 and a string containing the name of the slot. Used in CP_Object to find and register slots by name.


Constructor & Destructor Documentation

CP_SlotHolder::CP_SlotHolder  ) 
 

Constructor.

CP_SlotHolder::CP_SlotHolder const CP_String inSlotName,
CP_DataValueSlot  inSlot
 

Constructor.

Parameters:
inSlotName String containing the name of the slot stored in inSlot.
inSignal CP_Signal1 object. This is a CP_Slot that takes a single CP_DataValue parameter.

CP_SlotHolder::CP_SlotHolder const CP_SlotHolder inSlotHolder  ) 
 

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

Parameters:
inSlotHolder CP_SlotHolder to copy the data fields from.

CP_SlotHolder::~CP_SlotHolder  ) 
 

Destructor.


Member Function Documentation

CP_SlotHolder& CP_SlotHolder::operator= const CP_SlotHolder inSlotHolder  ) 
 

Assignment operator.

Parameters:
inSlotHolder CP_SlotHolder to copy the data fields from.
Returns:
CP_SlotHolder& Returns a reference to ourselves.

bool CP_SlotHolder::operator== const CP_SlotHolder inSlotHolder  ) 
 

Equality operator.

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

bool CP_SlotHolder::operator!= const CP_SlotHolder inSlotHolder  ) 
 

Inequality operator.

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

CP_String CP_SlotHolder::GetSlotName  )  const
 

Returns the name of the slot.

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

CP_DataValueSlot CP_SlotHolder::GetSlot  ) 
 

Returns the CP_DataValueSlot slot object

Returns:
CP_DataValueSlot Returns a CP_DataValueSlot object.


Member Data Documentation

CP_String CP_SlotHolder::fSlotName [protected]
 

CP_DataValueSlot CP_SlotHolder::fSlot [protected]
 

CP_String containing the name of the slot.


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