PixelLightAPI  .
Public Types | Public Member Functions | Static Public Attributes
PLCore::Attribute< T, ACCESS, STORAGE, DESC > Class Template Reference

Attribute of a class. More...

#include <Attribute.h>

Inheritance diagram for PLCore::Attribute< T, ACCESS, STORAGE, DESC >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Type< T >::_Type _Type

Public Member Functions

 Attribute (_Type DefaultValue, Object *pObject)
 Constructor.
virtual ~Attribute ()
 Destructor.
Attributeoperator= (const _Type &Value)
 Assignment operator.
virtual const VarDescGetDesc () const override
 Get var descriptor.

Static Public Attributes

static DESC Desc

Detailed Description

template<typename T, typename ACCESS, typename STORAGE, typename DESC>
class PLCore::Attribute< T, ACCESS, STORAGE, DESC >

Attribute of a class.

Remarks:
This class template represents attributes (variables that belong to objects).

Member Typedef Documentation

template<typename T , typename ACCESS , typename STORAGE , typename DESC >
typedef Type<T>::_Type PLCore::Attribute< T, ACCESS, STORAGE, DESC >::_Type

Reimplemented from PLCore::Var< T, ACCESS, STORAGE >.


Constructor & Destructor Documentation

template<typename T , typename ACCESS , typename STORAGE , typename DESC >
PLCore::Attribute< T, ACCESS, STORAGE, DESC >::Attribute ( _Type  DefaultValue,
Object pObject 
) [inline]

Constructor.

Parameters:
[in]DefaultValueDefault value for the attribute
[in]pObjectPointer to object to which the attribute belongs
template<typename T , typename ACCESS , typename STORAGE , typename DESC >
virtual PLCore::Attribute< T, ACCESS, STORAGE, DESC >::~Attribute ( ) [inline, virtual]

Destructor.


Member Function Documentation

template<typename T , typename ACCESS , typename STORAGE , typename DESC >
Attribute& PLCore::Attribute< T, ACCESS, STORAGE, DESC >::operator= ( const _Type Value) [inline]

Assignment operator.

Parameters:
[in]ValueNew value
Remarks:
Unfortunately, it is necessary to define assignment operators in the 'leaf'-classes, as they are not inherited from base classes. So we have to define it here and then call the implementation in the base class, which makes everything a bit more complicated

Reimplemented from PLCore::Var< T, ACCESS, STORAGE >.

template<typename T , typename ACCESS , typename STORAGE , typename DESC >
virtual const VarDesc* PLCore::Attribute< T, ACCESS, STORAGE, DESC >::GetDesc ( ) const [inline, override, virtual]

Get var descriptor.

Returns:
Var descriptor

Reimplemented from PLCore::DynVar.


Member Data Documentation

template<typename T , typename ACCESS , typename STORAGE , typename DESC >
DESC PLCore::Attribute< T, ACCESS, STORAGE, DESC >::Desc [static]

Attribute descriptor


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:24
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported