Variable descriptor. More...

#include <VarDesc.h>

Inheritance diagram for PLCore::VarDesc:

Public Member Functions
PLCORE_API	VarDesc (int nType, const String &sType, const String &sName, const String &sDescription, const String &sAnnotation)
	Constructor.
virtual PLCORE_API	~VarDesc ()
	Destructor.
PLCORE_API void	Dummy ()
	Initialize instance.
int	GetTypeID () const
	Get type ID.
String	GetTypeName () const
	Get type name.
virtual PLCORE_API String	GetDefault () const
	Get default value as string.
virtual PLCORE_API DynVar *	GetAttribute (const Object &cObject) const
	Get attribute.
Protected Attributes
int	m_nType
String	m_sType

Detailed Description

Variable descriptor.

Remarks:: This class contains a descriptor for a variable and consists of information belonging to a specific variable, such as it's name, type and description.

Constructor & Destructor Documentation

PLCORE_API PLCore::VarDesc::VarDesc	(	int	nType,
		const String &	sType,
		const String &	sName,
		const String &	sDescription,
		const String &	sAnnotation
	)

Parameters:

virtual PLCORE_API PLCore::VarDesc::~VarDesc ( ) [virtual]

Destructor.

PLCORE_API void PLCore::VarDesc::Dummy ( )

Initialize instance.

Remarks:: This method is just here to ensure, that the compiler will actually create static instances

int PLCore::VarDesc::GetTypeID ( ) const [inline]

Get type ID.

String PLCore::VarDesc::GetTypeName ( ) const [inline]

Get type name.

virtual PLCORE_API String PLCore::VarDesc::GetDefault ( ) const [virtual]

Get default value as string.

virtual PLCORE_API DynVar* PLCore::VarDesc::GetAttribute ( const Object & cObject ) const [virtual]

Get attribute.

Parameters:

[in] cObject Object to return the attribute pointer from

Returns:: Pointer to var (can be a null pointer, do not destroy the returned instance)

Type name

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