CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csDataObject Class Reference

A generic data object. More...

#include <dataobj.h>

Inheritance diagram for csDataObject:

csObject iObject iBase List of all members.

Public Methods

 csDataObject (void *d)
 Initialize this object with data pointer initialized to 'd'.

 ~csDataObject ()
 Destroy object.

void * GetData () const
 Get the data associated with this object.


Static Public Methods

void * GetData (iObject *obj)
 Get first data pointer associated with other object.


Public Attributes

csDataObject::DataObject scfiDataObject
 iDataObject implementation.


Protected Attributes

void * data
 Pointer to data.


Detailed Description

A generic data object.

This class contains a pointer to a generic, untyped block of data which is not destroyed when the csObject is freed. Users are encouraged to implement their own custom csObjects, but this one can be used as a general enough and simple data storage that can be added to any object.

Definition at line 32 of file dataobj.h.


Constructor & Destructor Documentation

csDataObject::csDataObject void *    d [inline]
 

Initialize this object with data pointer initialized to 'd'.

Definition at line 40 of file dataobj.h.

References data, SCF_CONSTRUCT_EMBEDDED_IBASE, SCF_CONSTRUCT_IBASE, and scfiDataObject.

csDataObject::~csDataObject   [inline]
 

Destroy object.

Definition at line 46 of file dataobj.h.

References SCF_DESTRUCT_EMBEDDED_IBASE, SCF_DESTRUCT_IBASE, and scfiDataObject.


Member Function Documentation

void* csDataObject::GetData iObject   obj [inline, static]
 

Get first data pointer associated with other object.

Definition at line 57 of file dataobj.h.

References CS_GET_CHILD_OBJECT.

void* csDataObject::GetData   const [inline]
 

Get the data associated with this object.

Definition at line 52 of file dataobj.h.

References data.


Member Data Documentation

void* csDataObject::data [protected]
 

Pointer to data.

Definition at line 36 of file dataobj.h.

Referenced by csDataObject(), and GetData().

csDataObject::DataObject csDataObject::scfiDataObject
 

iDataObject implementation.

Referenced by csDataObject(), and ~csDataObject().


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18