>xabsl	The Extensible Agent Behavior Specification Language
start  | team  | language reference  | tools  | xabsl engine  | download  | licence
XabslEngine Class Library Reference
xabsl::Parameters Class Reference #include <XabslParameters.h> Inheritance diagram for xabsl::Parameters: [legend]Collaboration diagram for xabsl::Parameters: [legend]List of all members. Detailed Description Represents the current set of parameters of a behavior or an input symbol. Definition at line 31 of file XabslParameters.h. Public Member Functions   Parameters (ErrorHandler &errorHandler)   Constructor. virtual  ~Parameters ()   Destructor. void  reset ()   Reset all parameters to default values (=0). void  registerEnumerations (NamedArray< Enumeration * > &enumerations)   Registers a reference to the enumerations of the engine This is only required when registerEnumerated is called afterwards. void  registerDecimal (const char *name, double &parameter)   Registers a reference to a decimal parameter at the parameters array. void  registerBoolean (const char *name, bool &parameter)   Registers a reference to a boolean parameter at the parameters array. void  registerEnumerated (const char *name, const char *enumName, int &parameter)   Registers a reference to an enumerated parameter at the parameters array. Public Attributes NamedArray< double * >  decimal   The decimal parameters. NamedArray< bool * >  boolean   The boolean parameters. NamedArray< int * >  enumerated   The enumerated parameters. NamedArray< const Enumeration * >  enumerations   The enumeration domain of the enumerated parameters. Protected Attributes ErrorHandler &  errorHandler   Used for error handling. Private Attributes NamedArray< Enumeration * > *  pEnumerations   Pointer to the enumerations of the engine. Constructor & Destructor Documentation xabsl::Parameters::Parameters (  ErrorHandler &  errorHandler  )  [inline]   Constructor. Parameters: errorHandler  A reference to a ErrorHandler instance Definition at line 38 of file XabslParameters.h. References pEnumerations. virtual xabsl::Parameters::~Parameters (   )  [inline, virtual]   Destructor. Definition at line 45 of file XabslParameters.h. Member Function Documentation void xabsl::Parameters::reset (   )    Reset all parameters to default values (=0). Definition at line 19 of file XabslParameters.cpp. References decimal, enumerated, enumerations, xabsl::Array< NamedArrayElement< int * > * >::getSize(), and xabsl::Array< NamedArrayElement< double * > * >::getSize(). Here is the call graph for this function: void xabsl::Parameters::registerEnumerations (  NamedArray< Enumeration * > &  enumerations  )    Registers a reference to the enumerations of the engine This is only required when registerEnumerated is called afterwards. Definition at line 26 of file XabslParameters.cpp. References pEnumerations. Referenced by xabsl::Engine::registerBasicBehavior(). void xabsl::Parameters::registerDecimal (  const char *  name, double &  parameter )    Registers a reference to a decimal parameter at the parameters array. Parameters: name  The name of the parameter parameter  The reference to a parameter Definition at line 31 of file XabslParameters.cpp. References xabsl::NamedArray< double * >::append(), decimal, xabsl::ErrorHandler::error(), xabsl::NamedArray< double * >::exists(), xabsl::ErrorHandler::message(), and XABSL_DEBUG_INIT. Here is the call graph for this function: void xabsl::Parameters::registerBoolean (  const char *  name, bool &  parameter )    Registers a reference to a boolean parameter at the parameters array. Parameters: name  The name of the parameter parameter  The reference to a parameter Definition at line 44 of file XabslParameters.cpp. References xabsl::ErrorHandler::error(), xabsl::ErrorHandler::message(), and XABSL_DEBUG_INIT. Here is the call graph for this function: void xabsl::Parameters::registerEnumerated (  const char *  name, const char *  enumName, int &  parameter )    Registers a reference to an enumerated parameter at the parameters array. Parameters: name  The name of the parameter enumName  The name of the corresponding enumeration parameter  The reference to a parameter Definition at line 57 of file XabslParameters.cpp. References xabsl::NamedArray< int * >::append(), xabsl::NamedArray< const Enumeration * >::append(), xabsl::Enumeration::enumElements, enumerated, enumerations, xabsl::ErrorHandler::error(), xabsl::NamedArray< Enumeration * >::exists(), xabsl::NamedArray< int * >::exists(), xabsl::Array< NamedArrayElement< EnumElement * > * >::getSize(), xabsl::ErrorHandler::message(), pEnumerations, and XABSL_DEBUG_INIT. Here is the call graph for this function: Member Data Documentation NamedArray<double*> xabsl::Parameters::decimal   The decimal parameters. Definition at line 52 of file XabslParameters.h. Referenced by xabsl::DecimalOptionParameterRef::DecimalOptionParameterRef(), xabsl::ParameterAssignment::ParameterAssignment(), registerDecimal(), and reset(). NamedArray<bool*> xabsl::Parameters::boolean   The boolean parameters. Definition at line 55 of file XabslParameters.h. Referenced by xabsl::BooleanOptionParameterRef::BooleanOptionParameterRef(), and xabsl::ParameterAssignment::ParameterAssignment(). NamedArray<int*> xabsl::Parameters::enumerated   The enumerated parameters. Definition at line 58 of file XabslParameters.h. Referenced by xabsl::EnumeratedOptionParameterRef::EnumeratedOptionParameterRef(), xabsl::ParameterAssignment::ParameterAssignment(), registerEnumerated(), and reset(). NamedArray<const Enumeration*> xabsl::Parameters::enumerations   The enumeration domain of the enumerated parameters. Definition at line 61 of file XabslParameters.h. Referenced by xabsl::EnumeratedOptionParameterRef::EnumeratedOptionParameterRef(), xabsl::ParameterAssignment::ParameterAssignment(), registerEnumerated(), and reset(). ErrorHandler& xabsl::Parameters::errorHandler [protected]   Used for error handling. Definition at line 93 of file XabslParameters.h. NamedArray<Enumeration*>* xabsl::Parameters::pEnumerations [private]   Pointer to the enumerations of the engine. Definition at line 97 of file XabslParameters.h. Referenced by Parameters(), registerEnumerated(), and registerEnumerations(). The documentation for this class was generated from the following files: XabslParameters.h XabslParameters.cpp Up | Main Page | Generated at Wed Aug 19 17:32:31 2009.
Copyright 2002 - 2009 by the XABSL developer team. See the licence for details.