PLCore::DynVar Class Reference

Virtual base class for variables. More...

#include <DynVar.h>

Inheritance diagram for PLCore::DynVar:

List of all members.

Public Member Functions
PLCORE_API	DynVar ()
	Constructor.
virtual PLCORE_API	~DynVar ()
	Destructor.
virtual PLCORE_API const VarDesc *	GetDesc () const
	Get variable descriptor.
virtual PLCORE_API DynTypeInfo &	GetType () const
	Get type.
virtual PLCORE_API int	GetTypeID () const
	Get type ID.
virtual PLCORE_API String	GetTypeName () const
	Get type name.
virtual PLCORE_API bool	IsDefault () const
	Check if variable is set to default value.
virtual PLCORE_API void	SetDefault ()
	Set variable to default value.
virtual PLCORE_API String	GetDefault () const
	Get default value as string.
virtual PLCORE_API void	SetVar (const DynVar &cValue)
	Set value.
virtual PLCORE_API bool	GetBool () const
	Get value.
virtual PLCORE_API void	SetBool (bool bValue)
	Set value.
virtual PLCORE_API int	GetInt () const
	Get value.
virtual PLCORE_API void	SetInt (int nValue)
	Set value.
virtual PLCORE_API int8	GetInt8 () const
	Get value.
virtual PLCORE_API void	SetInt8 (int8 nValue)
	Set value.
virtual PLCORE_API int16	GetInt16 () const
	Get value.
virtual PLCORE_API void	SetInt16 (int16 nValue)
	Set value.
virtual PLCORE_API int32	GetInt32 () const
	Get value.
virtual PLCORE_API void	SetInt32 (int32 nValue)
	Set value.
virtual PLCORE_API int64	GetInt64 () const
	Get value.
virtual PLCORE_API void	SetInt64 (int64 nValue)
	Set value.
virtual PLCORE_API uint8	GetUInt8 () const
	Get value.
virtual PLCORE_API void	SetUInt8 (uint8 nValue)
	Set value.
virtual PLCORE_API uint16	GetUInt16 () const
	Get value.
virtual PLCORE_API void	SetUInt16 (uint16 nValue)
	Set value.
virtual PLCORE_API uint32	GetUInt32 () const
	Get value.
virtual PLCORE_API void	SetUInt32 (uint32 nValue)
	Set value.
virtual PLCORE_API uint64	GetUInt64 () const
	Get value.
virtual PLCORE_API void	SetUInt64 (uint64 nValue)
	Set value.
virtual PLCORE_API uint_ptr	GetUIntPtr () const
	Get value.
virtual PLCORE_API void	SetUIntPtr (uint_ptr nValue)
	Set value.
virtual PLCORE_API float	GetFloat () const
	Get value.
virtual PLCORE_API void	SetFloat (float fValue)
	Set value.
virtual PLCORE_API double	GetDouble () const
	Get value.
virtual PLCORE_API void	SetDouble (double dValue)
	Set value.
virtual PLCORE_API String	GetString () const
	Get value.
virtual PLCORE_API void	SetString (const String &sValue)
	Set value.

---

Detailed Description

Virtual base class for variables.

Remarks:

This is the virtual base class to access variables and attributes dynamically. It is a virtual interface that allows you to access a variable regardless of it's actual type and storage.

---

Constructor & Destructor Documentation

PLCORE_API PLCore::DynVar::DynVar

(

)

Constructor.

virtual PLCORE_API PLCore::DynVar::~DynVar

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual PLCORE_API const VarDesc* PLCore::DynVar::GetDesc

(

)

const [virtual]

Get variable descriptor.

Returns:

Descriptor (can be a null pointer)

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

virtual PLCORE_API DynTypeInfo& PLCore::DynVar::GetType

(

)

const [virtual]

Get type.

Returns:

Type info

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

virtual PLCORE_API int PLCore::DynVar::GetTypeID

(

)

const [virtual]

Get type ID.

Returns:

Type ID

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

virtual PLCORE_API String PLCore::DynVar::GetTypeName

(

)

const [virtual]

Get type name.

Returns:

Type name (e.g. "int")

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

virtual PLCORE_API bool PLCore::DynVar::IsDefault

(

)

const [virtual]

Check if variable is set to default value.

Returns:

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

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

virtual PLCORE_API void PLCore::DynVar::SetDefault

(

)

[virtual]

Set variable to default value.

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

virtual PLCORE_API String PLCore::DynVar::GetDefault

(

)

const [virtual]

Get default value as string.

Returns:

Default value as string

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

virtual PLCORE_API void PLCore::DynVar::SetVar

(

const DynVar &

cValue

)

[virtual]

Set value.

Parameters:

[in]

cValue

Value as dynamic var

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

virtual PLCORE_API bool PLCore::DynVar::GetBool

(

)

const [virtual]

Get value.

Returns:

Value as bool

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

virtual PLCORE_API void PLCore::DynVar::SetBool

(

bool

bValue

)

[virtual]

Set value.

Parameters:

[in]

bValue

Value as bool

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

virtual PLCORE_API int PLCore::DynVar::GetInt

(

)

const [virtual]

Get value.

Returns:

Value as int

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

virtual PLCORE_API void PLCore::DynVar::SetInt

(

int

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as int

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

virtual PLCORE_API int8 PLCore::DynVar::GetInt8

(

)

const [virtual]

Get value.

Returns:

Value as int8

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

virtual PLCORE_API void PLCore::DynVar::SetInt8

(

int8

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as int8

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

virtual PLCORE_API int16 PLCore::DynVar::GetInt16

(

)

const [virtual]

Get value.

Returns:

Value as int16

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

virtual PLCORE_API void PLCore::DynVar::SetInt16

(

int16

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as int16

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

virtual PLCORE_API int32 PLCore::DynVar::GetInt32

(

)

const [virtual]

Get value.

Returns:

Value as int32

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

virtual PLCORE_API void PLCore::DynVar::SetInt32

(

int32

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as int32

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

virtual PLCORE_API int64 PLCore::DynVar::GetInt64

(

)

const [virtual]

Get value.

Returns:

Value as int64

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

virtual PLCORE_API void PLCore::DynVar::SetInt64

(

int64

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as int64

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

virtual PLCORE_API uint8 PLCore::DynVar::GetUInt8

(

)

const [virtual]

Get value.

Returns:

Value as uint8

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

virtual PLCORE_API void PLCore::DynVar::SetUInt8

(

uint8

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as uint8

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

virtual PLCORE_API uint16 PLCore::DynVar::GetUInt16

(

)

const [virtual]

Get value.

Returns:

Value as uint16

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

virtual PLCORE_API void PLCore::DynVar::SetUInt16

(

uint16

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as uint16

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

virtual PLCORE_API uint32 PLCore::DynVar::GetUInt32

(

)

const [virtual]

Get value.

Returns:

Value as uint32

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

virtual PLCORE_API void PLCore::DynVar::SetUInt32

(

uint32

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as uint32

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

virtual PLCORE_API uint64 PLCore::DynVar::GetUInt64

(

)

const [virtual]

Get value.

Returns:

Value as uint64

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

virtual PLCORE_API void PLCore::DynVar::SetUInt64

(

uint64

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as uint64

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

virtual PLCORE_API uint_ptr PLCore::DynVar::GetUIntPtr

(

)

const [virtual]

Get value.

Returns:

Value as uint_ptr

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

virtual PLCORE_API void PLCore::DynVar::SetUIntPtr

(

uint_ptr

nValue

)

[virtual]

Set value.

Parameters:

[in]

nValue

Value as uint_ptr

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

virtual PLCORE_API float PLCore::DynVar::GetFloat

(

)

const [virtual]

Get value.

Returns:

Value as float

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

virtual PLCORE_API void PLCore::DynVar::SetFloat

(

float

fValue

)

[virtual]

Set value.

Parameters:

[in]

fValue

Value as float

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

virtual PLCORE_API double PLCore::DynVar::GetDouble

(

)

const [virtual]

Get value.

Returns:

Value as double

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

virtual PLCORE_API void PLCore::DynVar::SetDouble

(

double

dValue

)

[virtual]

Set value.

Parameters:

[in]

dValue

Value as double

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

virtual PLCORE_API String PLCore::DynVar::GetString

(

)

const [virtual]

Get value.

Returns:

Value as string

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

virtual PLCORE_API void PLCore::DynVar::SetString

(

const String &

sValue

)

[virtual]

Set value.

Parameters:

[in]

sValue

Value as string

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

---

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

• DynVar.h