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

CP_Message Class Reference

List of all members.

Public Member Functions

 CP_Message ()
 CP_Message (void *inSendingObject, SInt32 inMsgType, SInt32 inMessage, SInt32 inData=0)
virtual ~CP_Message ()
void Clear ()
SInt32 GetMessage () const
void * GetSender () const
SInt32 GetType () const
SInt32 GetData () const
void SetMessage (const SInt32 inMessage)
void SetSender (void *inSender=NULL)
void SetType (const SInt32 inType)
void SetData (SInt32 inData)

Protected Attributes

SInt32 fMessage
SInt32 fMessageType
void * fSendingObject
SInt32 fData

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_Message::CP_Message  ) 
 

Constructor. This constructor creates an empty message with all fields set to 0.

CP_Message::CP_Message void *  inSendingObject,
SInt32  inMsgType,
SInt32  inMessage,
SInt32  inData = 0
 

Constructor. This constructor creates the message from the passed in parameters.

Parameters:
inSendingObject Object that is sending our message.
inMsgType The class that this message belongs to.
inMessage The message.
inData Any data sent with the message. Listener will interpret based on message type and message.

CP_Message::~CP_Message  )  [virtual]
 

Destructor.


Member Function Documentation

void CP_Message::Clear  ) 
 

Clear out the contents of this message. This will reset all fields to 0.

Returns:
void

SInt32 CP_Message::GetMessage  )  const
 

Return the SInt32 of this message.

void* CP_Message::GetSender  )  const
 

Return the sending object.

SInt32 CP_Message::GetType  )  const
 

Return the type of message contained in this message.

SInt32 CP_Message::GetData  )  const
 

Return any user supplied data.

void CP_Message::SetMessage const SInt32  inMessage  ) 
 

Set the SInt32 for this message.

void CP_Message::SetSender void *  inSender = NULL  ) 
 

Sets the sending object of this message.

void CP_Message::SetType const SInt32  inType  ) 
 

Sets the type of message this is.

void CP_Message::SetData SInt32  inData  ) 
 

Sets any user supplied data for this message.


Member Data Documentation

SInt32 CP_Message::fMessage [protected]
 

The message.

SInt32 CP_Message::fMessageType [protected]
 

The type of message being sent.

void* CP_Message::fSendingObject [protected]
 

The sending object.

SInt32 CP_Message::fData [protected]
 

Data attached to this message.


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