Neo  0.5.0
Developer Documentation
Neo::NeoVariable Class Reference

The NeoVariable class defines a variable that can be of any type available in M_VARIABLE_TYPE. More...

#include <PointerVariable.h>

Public Member Functions

 NeoVariable ()
 
 NeoVariable (const char *name, void *pointer, M_VARIABLE_TYPE type)
 
M_VARIABLE_TYPE getType (void)
 getType More...
 
const char * getName (void)
 getName More...
 
void * getPointer (void)
 getPointer More...
 

Detailed Description

The NeoVariable class defines a variable that can be of any type available in M_VARIABLE_TYPE.

This class is used by behaviors and the editor to store and process unknown data.

Constructor & Destructor Documentation

Neo::NeoVariable::NeoVariable ( )
inline
Neo::NeoVariable::NeoVariable ( const char *  name,
void *  pointer,
M_VARIABLE_TYPE  type 
)
inline

The MVariable constructor sets up a new MVariable object. It will not copy the name to an internal buffer so you have to provide memory for the name.

Parameters
nameThe name of the variable. Will not be copied to an internal buffer!
pointerThe pointer to the data. This one needs to be persistant so it can't point to a local variable or an element in a vector/deque etc.
typeThe type of this variable. This is an element of M_VARIABLE_TYPE.

Member Function Documentation

const char* Neo::NeoVariable::getName ( void  )
inline

getName

Returns
The pointer to the name.
void* Neo::NeoVariable::getPointer ( void  )
inline

getPointer

Returns
Returns the pointer with the data. This pointer complies to the type given by MVariable::getType
M_VARIABLE_TYPE Neo::NeoVariable::getType ( void  )
inline

getType

Returns
The variable type. Is element of enumaration M_VARIABLE_TYPE

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