libglass::Alias< T > Class Template Reference

#include <alias.h>

Inheritance diagram for libglass::Alias< T >:

libglass::_Alias libglass::PluginInterface

List of all members.

Public Member Functions

 Alias (const char *aliasname, T default_value) throw (Exception)
 ~Alias ()
bool addAlias (string &name, T t)
bool addAlias (const char *name, T t)
bool deleteAlias (const char *name)
bool checkAlias (void) const
getData (void)


Detailed Description

template<typename T>
class libglass::Alias< T >

Alias template class.

It's usually more efficient to store pointers to data than the data itself; that is, prefer Alias<yourclass *> to Alias<yourclass>.

Definition at line 201 of file alias.h.


Constructor & Destructor Documentation

template<typename T >
libglass::Alias< T >::Alias ( const char *  aliasname,
default_value 
) throw (Exception) [inline]

Definition at line 210 of file alias.h.

template<typename T >
libglass::Alias< T >::~Alias (  )  [inline]

Destructor.

Definition at line 217 of file alias.h.


Member Function Documentation

template<typename T >
bool libglass::Alias< T >::addAlias ( const char *  name,
t 
) [inline]

Definition at line 236 of file alias.h.

template<typename T >
bool libglass::Alias< T >::addAlias ( string name,
t 
) [inline]

Add an alias to function.

Parameters:
name The alias.
t The data.
Return values:
true If successful.
false Otherwise.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 228 of file alias.h.

template<typename T >
bool libglass::Alias< T >::checkAlias ( void   )  const [inline]

Checks if there's data associated with the current alias.

Return values:
true If there is.
false If there is not.

Definition at line 261 of file alias.h.

References libglass::_Alias::associated.

template<typename T >
bool libglass::Alias< T >::deleteAlias ( const char *  name  )  [inline]

Deletes an alias to function.

Parameters:
name The alias.
Return values:
true If successful.
false Alias doesn't exist.

Definition at line 250 of file alias.h.

template<typename T >
T libglass::Alias< T >::getData ( void   )  [inline]

Returns associated to the current alias.

Returns:
The associated data.

Definition at line 270 of file alias.h.

References libglass::_Alias::associated, and libglass::_Alias::current_association.


The documentation for this class was generated from the following file:

Generated on Fri May 28 13:19:01 2010 for libGlass by  doxygen 1.5.8