>xabsl   The Extensible Agent Behavior Specification Language

XabslEngine Class Library Reference

 

xabsl::OutputSymbol< T > Class Template Reference

#include <XabslSymbols.h>

Inheritance diagram for xabsl::OutputSymbol< T >:

Inheritance graph
[legend]
Collaboration diagram for xabsl::OutputSymbol< T >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class T>
class xabsl::OutputSymbol< T >

A Template for the output symbol classes.

Author:
Max Risler

Definition at line 227 of file XabslSymbols.h.


Public Member Functions

 OutputSymbol (const char *name, T *pVariable, int index)
 Constructor.

 OutputSymbol (const char *name, void(*pSetFunction)(T), T(*pGetFunction)(), int index)
 Constructor.

void setValue (T value)
 Set the value of the symbol.

getValue () const
 Returns the current value of the symbol.


Public Attributes

bool activeValueWasSet
 If true, the value was set during the last execution of the option graph.

int index
 Index of the symbol in array in corresponding engine.

lastValue
 Last set value of the output symbol.


Private Attributes

T * pV
 A pointer to a variable in the software environment.

void(* pSetF )(T)
 A pointer to a function that sets the value of the symbol in the software environment.

T(* pGetF )()
 A pointer to a function that gets the value of the symbol from the software environment.


Constructor & Destructor Documentation

template<class T>
xabsl::OutputSymbol< T >::OutputSymbol const char *  name,
T *  pVariable,
int  index
[inline]
 

Constructor.

Parameters:
name The name of the symbol, for debugging purposes
pVariable A pointer to the variable that the symbol stands for
index Index of the symbol in array in corresponding engine

Definition at line 236 of file XabslSymbols.h.

template<class T>
xabsl::OutputSymbol< T >::OutputSymbol const char *  name,
void(*  pSetFunction)(T),
T(*  pGetFunction)(),
int  index
[inline]
 

Constructor.

Parameters:
name The name of the symbol, for debugging purposes
pSetFunction A pointer to a boolean accepting function in the software environment
pGetFunction A pointer to a boolean returning function in the software environment
index Index of the symbol in array in corresponding engine

Definition at line 247 of file XabslSymbols.h.


Member Function Documentation

template<class T>
void xabsl::OutputSymbol< T >::setValue value  )  [inline]
 

Set the value of the symbol.

Definition at line 255 of file XabslSymbols.h.

template<class T>
T xabsl::OutputSymbol< T >::getValue  )  const [inline]
 

Returns the current value of the symbol.

Definition at line 270 of file XabslSymbols.h.


Member Data Documentation

template<class T>
bool xabsl::OutputSymbol< T >::activeValueWasSet
 

If true, the value was set during the last execution of the option graph.

Definition at line 283 of file XabslSymbols.h.

template<class T>
int xabsl::OutputSymbol< T >::index
 

Index of the symbol in array in corresponding engine.

Definition at line 286 of file XabslSymbols.h.

template<class T>
T xabsl::OutputSymbol< T >::lastValue
 

Last set value of the output symbol.

Definition at line 289 of file XabslSymbols.h.

template<class T>
T* xabsl::OutputSymbol< T >::pV [private]
 

A pointer to a variable in the software environment.

Definition at line 293 of file XabslSymbols.h.

template<class T>
void(* xabsl::OutputSymbol< T >::pSetF)(T) [private]
 

A pointer to a function that sets the value of the symbol in the software environment.

template<class T>
T(* xabsl::OutputSymbol< T >::pGetF)() [private]
 

A pointer to a function that gets the value of the symbol from the software environment.


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

Up | Main Page | Generated at Wed Aug 19 17:32:31 2009.