SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 > Class Template Reference

This class is an extended version of CL_BASE_OBJ class that allow you to have two unique ID for one object, a common example will be an image file that can be accessed via the filename(string) or via the texture ID(int). More...

#include <cl_base_DBL_obj.h>

Inheritance diagram for SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >:

Inheritance graph
[legend]
Collaboration diagram for SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

_SG_TLS_INLINE CL_BASE_DBL_OBJ (const IDType1 &_ID1)
 Default constructor.
_SG_TLS_INLINE CL_BASE_DBL_OBJ (const IDType2 &_ID2)
_SG_TLS_INLINE CL_BASE_DBL_OBJ (const IDType1 &_ID1, const IDType2 &_ID2)
_SG_TLS_INLINE ~CL_BASE_DBL_OBJ ()
 Default destructor.
template<typename IDType>
IDType GetID ()
template<typename IDType>
const CL_BASE_OBJ< IDType > * GetObj () const
 Return a reference to the CL_BASE_OBJ<IDType?> object.
template<typename IDType>
void SetID (IDType _ID)

Friends

class CL_TMPL_DBL_MANAGER

Detailed Description

template<typename IDType1 = std::string, typename IDType2 = int>
class SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >

This class is an extended version of CL_BASE_OBJ class that allow you to have two unique ID for one object, a common example will be an image file that can be accessed via the filename(string) or via the texture ID(int).

Note:
The template type define both type of values used to identify the object.
Author:
Yannick ALLUSSE


Constructor & Destructor Documentation

template<typename IDType1 = std::string, typename IDType2 = int>
_SG_TLS_INLINE SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >::CL_BASE_DBL_OBJ const IDType1 &  _ID1  )  [inline]
 

Default constructor.

Parameters:
_ID1 => Value of type IDType1 that identify the object.

template<typename IDType1 = std::string, typename IDType2 = int>
_SG_TLS_INLINE SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >::CL_BASE_DBL_OBJ const IDType2 &  _ID2  )  [inline]
 

Parameters:
_ID2 => Value of type IDType2 that identify the object.

template<typename IDType1 = std::string, typename IDType2 = int>
_SG_TLS_INLINE SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >::CL_BASE_DBL_OBJ const IDType1 &  _ID1,
const IDType2 &  _ID2
[inline]
 

Parameters:
_ID1 => Value of type IDType1 that identify the object.
_ID2 => Value of type IDType2 that identify the object.


Member Function Documentation

template<typename IDType1 = std::string, typename IDType2 = int>
template<typename IDType>
const CL_BASE_OBJ<IDType>* SGE::CL_BASE_DBL_OBJ< IDType1, IDType2 >::GetObj  )  const [inline]
 

Return a reference to the CL_BASE_OBJ<IDType?> object.

Returns:
A reference to the CL_BASE_OBJ<IDType?> object.


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