>xabsl   The Extensible Agent Behavior Specification Language

XabslEngine Class Library Reference

 

xabsl::InputSymbol< T > Class Template Reference

#include <XabslSymbols.h>

Inheritance diagram for xabsl::InputSymbol< T >:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class T>
class xabsl::InputSymbol< T >

A Template for the input symbol classes.

Author:
Martin Loetzsch

Definition at line 70 of file XabslSymbols.h.


Public Member Functions

 InputSymbol (const char *name, const T *pVariable, ErrorHandler &errorHandler, int index)
 Constructor.

 InputSymbol (const char *name, T(*pFunction)(), ErrorHandler &errorHandler, int index)
 Constructor.

getValue ()
 returns the value of the symbol

void parametersChanged () const
 Notify the software environment about a parameter change.


Public Attributes

Parameters parameters
 The parameters of the input symbol.

void(* pParametersChanged )()
 A Pointer to a parameter change notification function in the software environment.

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

lastValue
 Last queried value of the input symbol.


Private Attributes

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

T(* pF )()
 A pointer to a T returning function in the software environment.


Constructor & Destructor Documentation

template<class T>
xabsl::InputSymbol< T >::InputSymbol const char *  name,
const T *  pVariable,
ErrorHandler errorHandler,
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 79 of file XabslSymbols.h.

template<class T>
xabsl::InputSymbol< T >::InputSymbol const char *  name,
T(*  pFunction)(),
ErrorHandler errorHandler,
int  index
[inline]
 

Constructor.

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

Definition at line 89 of file XabslSymbols.h.


Member Function Documentation

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

returns the value of the symbol

Definition at line 95 of file XabslSymbols.h.

template<class T>
void xabsl::InputSymbol< T >::parametersChanged  )  const [inline]
 

Notify the software environment about a parameter change.

Definition at line 99 of file XabslSymbols.h.


Member Data Documentation

template<class T>
Parameters xabsl::InputSymbol< T >::parameters
 

The parameters of the input symbol.

Definition at line 103 of file XabslSymbols.h.

template<class T>
void(* xabsl::InputSymbol< T >::pParametersChanged)()
 

A Pointer to a parameter change notification function in the software environment.

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

Index of the symbol in array in corresponding engine.

Definition at line 109 of file XabslSymbols.h.

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

Last queried value of the input symbol.

Definition at line 112 of file XabslSymbols.h.

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

A pointer to a variable in the software environment.

Definition at line 116 of file XabslSymbols.h.

template<class T>
T(* xabsl::InputSymbol< T >::pF)() [private]
 

A pointer to a T returning function in 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.