SGE::CL_BASE_OBJ< IDType > Class Template Reference

The class if the very base class of objects that are used in CL_TEMPLATE_MANAGER. More...

#include <cl_base_obj.h>

Collaboration diagram for SGE::CL_BASE_OBJ< IDType >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

_SG_TLS_INLINE CL_BASE_OBJ ()
 Constructor used by the class CL_BASE_DBL_OBJ when we know only one of the ID.
_SG_TLS_INLINE CL_BASE_OBJ (const IDType &_ID)
 Default constructor.
_SG_TLS_INLINE ~CL_BASE_OBJ ()
 Default destructor.
_SG_TLS_INLINE const IDType & GetID () const
 Return a const reference to the ID value.
_SG_TLS_INLINE const std::string GetIDStr ()
 Return a string version of the ID value.
virtual _SG_TLS_INLINE const
std::string 
GetValStr ()
 Return a string version of the object value. Must be redefined in all the herited objects.

Protected Member Functions

_SG_TLS_INLINE void SetID (const IDType &_ID)
 Set the value of ID.

Protected Attributes

IDType ID
 IDType value that identify the object. (a kind of primary key).

Friends

class CL_TEMPLATE_OBJECT_MANAGER

Detailed Description

template<typename IDType = std::string>
class SGE::CL_BASE_OBJ< IDType >

The class if the very base class of objects that are used in CL_TEMPLATE_MANAGER.

Note:
The template type define the type of the value that will be used to identify the object.
Author:
Yannick ALLUSSE


Constructor & Destructor Documentation

template<typename IDType = std::string>
_SG_TLS_INLINE SGE::CL_BASE_OBJ< IDType >::CL_BASE_OBJ const IDType &  _ID  )  [inline]
 

Default constructor.

Parameters:
_ID => Value of type IDType that identify the object.


Member Function Documentation

template<typename IDType = std::string>
_SG_TLS_INLINE const IDType& SGE::CL_BASE_OBJ< IDType >::GetID  )  const [inline]
 

Return a const reference to the ID value.

Returns:
A const reference to the ID value.

template<typename IDType = std::string>
_SG_TLS_INLINE const std::string SGE::CL_BASE_OBJ< IDType >::GetIDStr  )  [inline]
 

Return a string version of the ID value.

Returns:
A string version of the ID value.

template<typename IDType = std::string>
virtual _SG_TLS_INLINE const std::string SGE::CL_BASE_OBJ< IDType >::GetValStr  )  [inline, virtual]
 

Return a string version of the object value. Must be redefined in all the herited objects.

Returns:
A string version of the object value.


The documentation for this class was generated from the following file:
Generated on Mon Mar 19 23:15:11 2007 for SugoiTools by  doxygen 1.4.6-NO