Typed variable. More...

#include <Var.h>

Inheritance diagram for PLCore::Var< T, ACCESS, STORAGE >:

Public Types
typedef Type< T >::_Type	_Type
Public Member Functions
	Var ()
	Constructor.
	Var (_Type DefaultValue)
	Constructor.
	Var (_Type DefaultValue, Object *pObject)
	Constructor.
virtual	~Var ()
	Destructor.
	operator _Type () const
	Get value.
Var &	operator= (const _Type &Value)
	Assignment operator.
_Type	Get () const
	Get value.
void	Set (const _Type &Value)
	Set value.
_Type	Default () const
	Get default value.
virtual DynTypeInfo &	GetType () const override
	Get type.
virtual String	GetTypeName () const override
	Get type name.
virtual int	GetTypeID () const override
	Get type ID.
virtual bool	IsDefault () const override
	Check if variable is set to default value.
virtual void	SetDefault () override
	Set variable to default value.
virtual String	GetDefault () const override
	Get default value as string.
virtual void	SetVar (const DynVar &cValue) override
	Set value.
virtual bool	GetBool () const override
	Get value.
virtual void	SetBool (bool bValue) override
	Set value.
virtual int	GetInt () const override
	Get value.
virtual void	SetInt (int nValue) override
	Set value.
virtual int8	GetInt8 () const override
	Get value.
virtual void	SetInt8 (int8 nValue) override
	Set value.
virtual int16	GetInt16 () const override
	Get value.
virtual void	SetInt16 (int16 nValue) override
	Set value.
virtual int32	GetInt32 () const override
	Get value.
virtual void	SetInt32 (int32 nValue) override
	Set value.
virtual int64	GetInt64 () const override
	Get value.
virtual void	SetInt64 (int64 nValue) override
	Set value.
virtual uint8	GetUInt8 () const override
	Get value.
virtual void	SetUInt8 (uint8 nValue) override
	Set value.
virtual uint16	GetUInt16 () const override
	Get value.
virtual void	SetUInt16 (uint16 nValue) override
	Set value.
virtual uint32	GetUInt32 () const override
	Get value.
virtual void	SetUInt32 (uint32 nValue) override
	Set value.
virtual uint64	GetUInt64 () const override
	Get value.
virtual void	SetUInt64 (uint64 nValue) override
	Set value.
virtual uint_ptr	GetUIntPtr () const override
	Get value.
virtual void	SetUIntPtr (uint_ptr nValue) override
	Set value.
virtual float	GetFloat () const override
	Get value.
virtual void	SetFloat (float fValue) override
	Set value.
virtual double	GetDouble () const override
	Get value.
virtual void	SetDouble (double dValue) override
	Set value.
virtual String	GetString () const override
	Get value.
virtual void	SetString (const String &sValue) override
	Set value.

Detailed Description

template<typename T, typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>
class PLCore::Var< T, ACCESS, STORAGE >

Typed variable.

Remarks:: This class represents an actual variable of a certain type. The two other template parameters control, where the actual value is stored (STORAGE) and how the variable is allowed to be accessed (ACCESS).

Member Typedef Documentation

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

typedef Type<T>::_Type PLCore::Var< T, ACCESS, STORAGE >::_Type

Reimplemented in PLCore::Attribute< T, ACCESS, STORAGE, DESC >.

Constructor & Destructor Documentation

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

PLCore::Var< T, ACCESS, STORAGE >::Var ( ) [inline]

Constructor.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

PLCore::Var< T, ACCESS, STORAGE >::Var ( _Type DefaultValue ) [inline]

Constructor.

Parameters:

[in] DefaultValue Default value for the var

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

PLCore::Var< T, ACCESS, STORAGE >::Var	(	_Type	DefaultValue,
		Object *	pObject
	)		`[inline]`

Constructor.

Parameters:

[in]	DefaultValue	Default value for the var
[in]	pObject	Pointer to object to which the attribute belongs

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual PLCore::Var< T, ACCESS, STORAGE >::~Var ( ) [inline, virtual]

Destructor.

Member Function Documentation

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

PLCore::Var< T, ACCESS, STORAGE >::operator _Type ( ) const [inline]

Get value.

Returns:: Value

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

Var& PLCore::Var< T, ACCESS, STORAGE >::operator= ( const _Type & Value ) [inline]

Assignment operator.

Parameters:

[in] Value New value

Returns:: Reference to this instance

Reimplemented in PLCore::Attribute< T, ACCESS, STORAGE, DESC >.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

_Type PLCore::Var< T, ACCESS, STORAGE >::Get ( ) const [inline]

Get value.

Returns:: Value

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

void PLCore::Var< T, ACCESS, STORAGE >::Set ( const _Type & Value ) [inline]

Set value.

Parameters:

[in] Value New value

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

_Type PLCore::Var< T, ACCESS, STORAGE >::Default ( ) const [inline]

Get default value.

Returns:: Default value

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual DynTypeInfo& PLCore::Var< T, ACCESS, STORAGE >::GetType ( ) const [inline, override, virtual]

Get type.

Returns:: Type info

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual String PLCore::Var< T, ACCESS, STORAGE >::GetTypeName ( ) const [inline, override, virtual]

Get type name.

Returns:: Type name (e.g. "int")

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int PLCore::Var< T, ACCESS, STORAGE >::GetTypeID ( ) const [inline, override, virtual]

Get type ID.

Returns:: Type ID

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual bool PLCore::Var< T, ACCESS, STORAGE >::IsDefault ( ) const [inline, override, virtual]

Check if variable is set to default value.

Returns:: 'true' if default value is set, else 'false'

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetDefault ( ) [inline, override, virtual]

Set variable to default value.

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual String PLCore::Var< T, ACCESS, STORAGE >::GetDefault ( ) const [inline, override, virtual]

Get default value as string.

Returns:: Default value as string

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetVar ( const DynVar< T, ACCESS, STORAGE > & cValue ) [inline, override, virtual]

Set value.

Parameters:

[in] cValue Value as dynamic var

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual bool PLCore::Var< T, ACCESS, STORAGE >::GetBool ( ) const [inline, override, virtual]

Get value.

Returns:: Value as bool

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetBool ( bool bValue ) [inline, override, virtual]

Set value.

Parameters:

[in] bValue Value as bool

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int PLCore::Var< T, ACCESS, STORAGE >::GetInt ( ) const [inline, override, virtual]

Get value.

Returns:: Value as int

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetInt ( int nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as int

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int8 PLCore::Var< T, ACCESS, STORAGE >::GetInt8 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as int8

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetInt8 ( int8 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as int8

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int16 PLCore::Var< T, ACCESS, STORAGE >::GetInt16 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as int16

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetInt16 ( int16 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as int16

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int32 PLCore::Var< T, ACCESS, STORAGE >::GetInt32 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as int32

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetInt32 ( int32 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as int32

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual int64 PLCore::Var< T, ACCESS, STORAGE >::GetInt64 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as int64

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetInt64 ( int64 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as int64

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual uint8 PLCore::Var< T, ACCESS, STORAGE >::GetUInt8 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as uint8

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetUInt8 ( uint8 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as uint8

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual uint16 PLCore::Var< T, ACCESS, STORAGE >::GetUInt16 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as uint16

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetUInt16 ( uint16 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as uint16

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual uint32 PLCore::Var< T, ACCESS, STORAGE >::GetUInt32 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as uint32

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetUInt32 ( uint32 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as uint32

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual uint64 PLCore::Var< T, ACCESS, STORAGE >::GetUInt64 ( ) const [inline, override, virtual]

Get value.

Returns:: Value as uint64

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetUInt64 ( uint64 nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as uint64

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual uint_ptr PLCore::Var< T, ACCESS, STORAGE >::GetUIntPtr ( ) const [inline, override, virtual]

Get value.

Returns:: Value as uint_ptr

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetUIntPtr ( uint_ptr nValue ) [inline, override, virtual]

Set value.

Parameters:

[in] nValue Value as uint_ptr

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual float PLCore::Var< T, ACCESS, STORAGE >::GetFloat ( ) const [inline, override, virtual]

Get value.

Returns:: Value as float

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetFloat ( float fValue ) [inline, override, virtual]

Set value.

Parameters:

[in] fValue Value as float

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual double PLCore::Var< T, ACCESS, STORAGE >::GetDouble ( ) const [inline, override, virtual]

Get value.

Returns:: Value as double

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetDouble ( double dValue ) [inline, override, virtual]

Set value.

Parameters:

[in] dValue Value as double

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual String PLCore::Var< T, ACCESS, STORAGE >::GetString ( ) const [inline, override, virtual]

Get value.

Returns:: Value as string

Reimplemented from PLCore::DynVar.

template<typename T , typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>

virtual void PLCore::Var< T, ACCESS, STORAGE >::SetString ( const String & sValue ) [inline, override, virtual]

Set value.

Parameters:

[in] sValue Value as string

Reimplemented from PLCore::DynVar.

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

Var.h

Public Types

Public Member Functions

Detailed Description

template<typename T, typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue> class PLCore::Var< T, ACCESS, STORAGE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename T, typename ACCESS = PLCore::AccessReadWrite, typename STORAGE = PLCore::StorageDirectValue>
class PLCore::Var< T, ACCESS, STORAGE >