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

CP_DataValueList Class Reference

A class to hold a bunch of CP_DataValueHolder objects that can be accessed by a string tag holding the name of the data value.

Inheritance diagram for CP_DataValueList:

CP_Object CP_SigSlot::CP_SlotObject CP_NoCopy List of all members.

Public Member Functions

void ClearList ()
UInt32 GetCount ()
void SetID (FourCharCode inIdentifier)
FourCharCode GetID ()
void RegisterSignal (const CP_SignalHolder &inSignal)
CP_DataValueSignal * FindSignal (const CP_String &inSignalName)
UInt32 GetNumberSignals ()
CP_String GetNthSignalName (UInt32 inSignalIndex)
void RegisterSlot (const CP_SlotHolder &inSlot)
CP_DataValueSlot FindSlot (const CP_String &inSlotName)
UInt32 GetNumberSlots ()
CP_String GetNthSlotName (UInt32 inSlotIndex)
template<class R, class P1, class P2>
CP_CommandHandlerSignal * Connect (CPLAT::CP_CommandNo cmd, void(R::*handler)(P1, P2), SInt32 mode)
template<class R, class P1, class P2>
void Connect (CP_Object *control, const CPLAT::CP_String &signalName, void(R::*handler)(P1, P2))
void disconnect_all ()
void signal_connect (CP_Signal *inSender)
void signal_disconnect (CP_Signal *inSender)
Constructor / Destructor
 CP_DataValueList ()
 Constructor.
 CP_DataValueList (const CP_DataValueList &inDataValueList)
virtual ~CP_DataValueList ()
 Destructor.
Data Value
void AddValue (const CP_String &inDataKey, const CP_DataValueHolder &inDataValue)
void SetValue (const CP_String &inDataKey, const CP_DataValueHolder &inDataValue)
void RemoveValue (const CP_String &inDataKey)
bool GetOptionalValue (const CP_String &inDataKey, CP_DataValueHolder &inOutDataValue)
operators
CP_DataValueList & operator= (const CP_DataValueList &inDataValueList)

Static Public Member Functions

static void Connect (CP_Object *sender, const CP_String &signalName, CP_Object *receiver, const CP_String &slotName, const bool reciprocal=false)
static void Connect (CP_Object *sender, CP_Object *receiver, const bool reciprocal=false, const CP_String &signalName=kCP_Signal_ValueChanged, const CP_String &slotName=kCP_Slot_SetValue)

Protected Attributes

CP_DataValue_Map fDataValues
CP_DataValueSignal fValueChangedSignal
CP_Signals_Array * fSignals
CP_Slots_Array * fSlots
FourCharCode fObjectID
sender_set fSenders

Static Protected Attributes

static FourCharCode fObjectIDCount = 0

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_DataValueList::CP_DataValueList (   ) 
 

Constructor.

Exceptions:
none 

CP_DataValueList::CP_DataValueList (  const CP_DataValueList &  inDataValueList  ) 
 

Copy constructor.

Parameters:
inDataValueList Data value list to copy fields from.
Exceptions:
none 

CP_DataValueList::~CP_DataValueList (   )  [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

void CP_DataValueList::AddValue (  const CP_String &  inDataKey,
const CP_DataValueHolder &  inDataValue
) 
 

Adds the passed in data value holder and key string to the list of data value keys this list holds.

Parameters:
inDataKey The key used to retrieve the data value.
inDataValue The CP_DataValueHolder that holds the actual data value.
Exceptions:
none 
Returns:
void

void CP_DataValueList::SetValue (  const CP_String &  inDataKey,
const CP_DataValueHolder &  inDataValue
) 
 

Sets the value for the passed in data key to the value supplied in inDataValue. This is used if you want to change an existing value in this data value list.

If there is no value with the passed in inDataKey, then a new entry is added to the end of the list.

Parameters:
inDataKey The key for the data value.
inDataValue The CP_DataValueHolder that holds the new data value.
Exceptions:
none 
Returns:
void

void CP_DataValueList::RemoveValue (  const CP_String &  inDataKey  ) 
 

Removes a value from the list with the passed in key.

Exceptions:
none 
Returns:
void

bool CP_DataValueList::GetOptionalValue (  const CP_String &  inDataKey,
CP_DataValueHolder &  inOutDataValue
) 
 

Returns a data value in the passed in parameter from the data key. If the data specified by the key does not exist, then false is returned.

Parameters:
inDataKey The key used to retrieve the data value.
inDataValue The CP_DataValueHolder to return the result in.
Exceptions:
none 
Returns:
bool Returns true if the data key was found. False if there was no matching key.

void CP_DataValueList::ClearList (   ) 
 

Erases all entries in the list.

Exceptions:
none 
Returns:
void

UInt32 CP_DataValueList::GetCount (   ) 
 

CP_DataValueList & CP_DataValueList::operator= (  const CP_DataValueList &  inDataValueList  ) 
 

Assignment operator.

Parameters:
inDataValueList The data value list to copy the data from.
Exceptions:
none 
Returns:
CP_DataValueList Returns a reference to ourselves.

void CP_Object::SetID (  FourCharCode  inIdentifier  )  [inherited]
 

Sets the identifier for this object. If a specific identifier is not set with this function, then a default id is used, which is simply a running count of the number of objects created.

Parameters:
inIdentifier The objects identifier.
Returns:
void

FourCharCode CP_Object::GetID (   )  [inherited]
 

Returns the objects identifier.

Returns:
FourCharCode The identifier of this object.

void CP_Object::RegisterSignal (  const CP_SignalHolder &  inSignal  )  [inherited]
 

Registers the signal / signal name contained in the passed in inSignal object.

Parameters:
inSignal CP_SignalHolder that holds a signal and string identifier.
Returns:
void

CP_DataValueSignal * CP_Object::FindSignal (  const CP_String &  inSignalName  )  [inherited]
 

Finds the CP_DataValueSignal object that matches the passed in inSignalName.

Parameters:
inSignalName CP_String containing the identifier of the signal to return.
Returns:
CP_DataValueSignal * Returns a pointer to a CP_DataValueSignal object.

UInt32 CP_Object::GetNumberSignals (   )  [inherited]
 

Returns the number of signals for this object.

Returns:
UInt32 The number of signals.

CP_String CP_Object::GetNthSignalName (  UInt32  inSignalIndex  )  [inherited]
 

Returns the signal name of the passed in signal index.

Parameters:
inSignalIndex Index of the name of the signal to return.
Returns:
CP_String The name of the nth signal being returned.

void CP_Object::RegisterSlot (  const CP_SlotHolder &  inSlot  )  [inherited]
 

Registers the slot / slot name contained in the passed in inSlot object.

Parameters:
inSlot CP_SignalHolder that holds a slot and string identifier.
Returns:
void

CP_DataValueSlot CP_Object::FindSlot (  const CP_String &  inSlotName  )  [inherited]
 

Finds the CP_Slot1 object that matches the passed in inSlotName.

Parameters:
inSlotName CP_String containing the identifier of the slot to return.
Returns:
CP_DataValueSlot Returns a pointer to a CP_DataValueSlot object.

UInt32 CP_Object::GetNumberSlots (   )  [inherited]
 

Returns the number of slots for this object.

Returns:
UInt32 The number of slots.

CP_String CP_Object::GetNthSlotName (  UInt32  inSlotIndex  )  [inherited]
 

Returns the slot name of the passed in signal index.

Parameters:
inSlotIndex Index of the name of the slot to return.
Returns:
CP_String The name of the nth slot being returned.

template<class R, class P1, class P2>
CP_CommandHandlerSignal* CP_Object::Connect (  CPLAT::CP_CommandNo  cmd,
void(R::*)(P1, P2)  handler,
SInt32  mode
)  [inherited]
 

template<class R, class P1, class P2>
void CP_Object::Connect (  CP_Object *  control,
const CPLAT::CP_String &  signalName,
void(R::*)(P1, P2)  handler
)  [inherited]
 

void CP_Object::Connect (  CP_Object *  sender,
const CP_String &  signalName,
CP_Object *  receiver,
const CP_String &  slotName,
const bool  reciprocal = false
)  [static, inherited]
 

void CP_Object::Connect (  CP_Object *  sender,
CP_Object *  receiver,
const bool  reciprocal = false,
const CP_String &  signalName = kCP_Signal_ValueChanged,
const CP_String &  slotName = kCP_Slot_SetValue
)  [static, inherited]
 

void CP_SigSlot::CP_SlotObject::disconnect_all (   )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_connect (  CP_Signal *  inSender  )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_disconnect (  CP_Signal *  inSender  )  [inherited]
 

Member Data Documentation

CP_DataValue_Map CP_DataValueList::fDataValues [protected]
 

CP_DataValueSignal CP_DataValueList::fValueChangedSignal [protected]
 

Holds the list of data values.

CP_Signals_Array* CP_Object::fSignals [protected, inherited]
 

CP_Slots_Array* CP_Object::fSlots [protected, inherited]
 

List of registered signals for this object.

FourCharCode CP_Object::fObjectID [protected, inherited]
 

List of registered slots for this object.

CPLAT_Begin_Namespace_CPLAT FourCharCode CP_Object::fObjectIDCount = 0 [static, protected, inherited]
 

Object identifier.

sender_set CP_SigSlot::CP_SlotObject::fSenders [protected, inherited]
 

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:27 2005 for CPLAT by  doxygen 1.4.0