>xabsl	The Extensible Agent Behavior Specification Language
start  | team  | language reference  | tools  | xabsl engine  | download  | licence
XabslEngine Class Library Reference
xabsl::Action Class Reference #include <XabslAction.h> Inheritance diagram for xabsl::Action: [legend]List of all members. Detailed Description Represents an action execution. This is either a subsequent option or basic behavior to be executed, or an output symbol assignment. Author: Max Risler Definition at line 31 of file XabslAction.h. Public Member Functions   Action (const unsigned &time)   Constructor. virtual  ~Action ()   Virtual destructor. virtual void  execute ()=0   Execute the behavior or assign the output symbol. Behavior *  getBehavior ()   Returns a pointer to the option or basic behavior to be executed, or 0 if an output symbol is set. const Behavior *  getBehavior () const Option *  getOption ()   Returns a pointer to the option, if an option is to be executed, 0 otherwise. const Option *  getOption () const BasicBehavior *  getBasicBehavior ()   Returns a pointer to the basic behavior, if a basic behavior is to be executed, 0 otherwise. const BasicBehavior *  getBasicBehavior () const ParameterAssignment *  getParameters ()   Returns a pointer to the parameter assignments for an option or basic behavior, or 0 if an output symbol is set. const ParameterAssignment *  getParameters () const const DecimalOutputSymbol *  getDecimalOutputSymbol () const   Returns a pointer to the output symbol, if a decimal output symbol is to be assigned, 0 otherwise. const BooleanOutputSymbol *  getBooleanOutputSymbol () const   Returns a pointer to the output symbol, if a boolean output symbol is to be assigned, 0 otherwise. const EnumeratedOutputSymbol *  getEnumeratedOutputSymbol () const   Returns a pointer to the output symbol, if an enumerated output symbol is to be assigned, 0 otherwise. double  getDecimalOutputSymbolValue () const   Returns the last symbol value, if a decimal output symbol is to be assigned, 0 otherwise. bool  getBooleanOutputSymbolValue () const   Returns the last symbol value, if a boolean output symbol is to be assigned, 0 otherwise. int  getEnumeratedOutputSymbolValue () const   Returns the last symbol value, if an enumerated output symbol is to be assigned, 0 otherwise. Static Public Member Functions Action *  create (InputSource &input, NamedArray< Option * > &options, NamedArray< BasicBehavior * > &basicBehaviors, Symbols &symbols, Option &option, State &state, ErrorHandler &errorHandler, const unsigned &time)   Creates an action definition. Action *  create (Behavior *behavior, ErrorHandler &errorHandler, const unsigned &time)   Creates an action definition which just calls a single option or basic behavior without setting any parameters. Protected Attributes const unsigned &  time   The system time in ms. Constructor & Destructor Documentation xabsl::Action::Action (  const unsigned &  time  )  [inline]   Constructor. Parameters: time  The system time in ms. Definition at line 38 of file XabslAction.h. virtual xabsl::Action::~Action (   )  [inline, virtual]   Virtual destructor. Definition at line 45 of file XabslAction.h. Member Function Documentation Action * xabsl::Action::create (  InputSource &  input, NamedArray< Option * > &  options, NamedArray< BasicBehavior * > &  basicBehaviors, Symbols &  symbols, Option &  option, State &  state, ErrorHandler &  errorHandler, const unsigned &  time )  [static]   Creates an action definition. Parameters: input  An input source for the intermediate code. It must be opened and read until A position where a state starts. options  All available options basicBehaviors  All available basicBehaviors symbols  All available symbols option  The current option state  The current state errorHandler  A reference to a ErrorHandler instance time  The system time in ms. Definition at line 16 of file XabslAction.cpp. References xabsl::ActionBasicBehavior::basicBehavior, xabsl::ActionBooleanOutputSymbol::booleanOutputSymbol, xabsl::ActionBooleanOutputSymbol::booleanOutputSymbolExpression, xabsl::Symbols::booleanOutputSymbols, xabsl::ParameterAssignment::create(), xabsl::ActionDecimalOutputSymbol::decimalOutputSymbol, xabsl::ActionDecimalOutputSymbol::decimalOutputSymbolExpression, xabsl::Symbols::decimalOutputSymbols, xabsl::ActionEnumeratedOutputSymbol::enumeratedOutputSymbol, xabsl::ActionEnumeratedOutputSymbol::enumeratedOutputSymbolExpression, xabsl::Symbols::enumeratedOutputSymbols, xabsl::EnumeratedOutputSymbol::enumeration, xabsl::ErrorHandler::error(), xabsl::ErrorHandler::errorsOccurred, xabsl::NamedArray< EnumeratedOutputSymbol * >::exists(), xabsl::NamedArray< BooleanOutputSymbol * >::exists(), xabsl::NamedArray< DecimalOutputSymbol * >::exists(), xabsl::NamedArray< T >::exists(), xabsl::ErrorHandler::message(), xabsl::ActionOption::option, xabsl::Behavior::parameters, xabsl::ActionBehavior::parameters, xabsl::InputSource::readString(), and XABSL_DEBUG_INIT. Here is the call graph for this function: Action * xabsl::Action::create (  Behavior *  behavior, ErrorHandler &  errorHandler, const unsigned &  time )  [static]   Creates an action definition which just calls a single option or basic behavior without setting any parameters. Parameters: behavior  The referenced option or basic behavior. errorHandler  A reference to a ErrorHandler instance time  The system time in ms. Definition at line 142 of file XabslAction.cpp. References xabsl::Behavior::parameters, and xabsl::ActionBehavior::parameters. virtual void xabsl::Action::execute (   )  [pure virtual]   Execute the behavior or assign the output symbol. Implemented in xabsl::ActionBehavior, xabsl::ActionDecimalOutputSymbol, xabsl::ActionBooleanOutputSymbol, and xabsl::ActionEnumeratedOutputSymbol. Behavior * xabsl::Action::getBehavior (   )    Returns a pointer to the option or basic behavior to be executed, or 0 if an output symbol is set. Reimplemented in xabsl::ActionBehavior, xabsl::ActionBasicBehavior, and xabsl::ActionOption. Definition at line 236 of file XabslAction.cpp. References xabsl::ActionBehavior::getBehavior(). Here is the call graph for this function: const Behavior * xabsl::Action::getBehavior (   )  const   Reimplemented in xabsl::ActionBehavior, xabsl::ActionBasicBehavior, and xabsl::ActionOption. Definition at line 260 of file XabslAction.cpp. References xabsl::ActionBehavior::getBehavior(). Here is the call graph for this function: Option * xabsl::Action::getOption (   )    Returns a pointer to the option, if an option is to be executed, 0 otherwise. Definition at line 244 of file XabslAction.cpp. References xabsl::ActionOption::option. const Option * xabsl::Action::getOption (   )  const   Definition at line 268 of file XabslAction.cpp. References xabsl::ActionOption::option. BasicBehavior * xabsl::Action::getBasicBehavior (   )    Returns a pointer to the basic behavior, if a basic behavior is to be executed, 0 otherwise. Definition at line 252 of file XabslAction.cpp. References xabsl::ActionBasicBehavior::basicBehavior. const BasicBehavior * xabsl::Action::getBasicBehavior (   )  const   Definition at line 276 of file XabslAction.cpp. References xabsl::ActionBasicBehavior::basicBehavior. ParameterAssignment * xabsl::Action::getParameters (   )    Returns a pointer to the parameter assignments for an option or basic behavior, or 0 if an output symbol is set. Definition at line 284 of file XabslAction.cpp. References xabsl::ActionBehavior::parameters. const ParameterAssignment * xabsl::Action::getParameters (   )  const   Definition at line 292 of file XabslAction.cpp. References xabsl::ActionBehavior::parameters. const DecimalOutputSymbol * xabsl::Action::getDecimalOutputSymbol (   )  const   Returns a pointer to the output symbol, if a decimal output symbol is to be assigned, 0 otherwise. Definition at line 300 of file XabslAction.cpp. References xabsl::ActionDecimalOutputSymbol::decimalOutputSymbol. const BooleanOutputSymbol * xabsl::Action::getBooleanOutputSymbol (   )  const   Returns a pointer to the output symbol, if a boolean output symbol is to be assigned, 0 otherwise. Definition at line 308 of file XabslAction.cpp. References xabsl::ActionBooleanOutputSymbol::booleanOutputSymbol. const EnumeratedOutputSymbol * xabsl::Action::getEnumeratedOutputSymbol (   )  const   Returns a pointer to the output symbol, if an enumerated output symbol is to be assigned, 0 otherwise. Definition at line 316 of file XabslAction.cpp. References xabsl::ActionEnumeratedOutputSymbol::enumeratedOutputSymbol. double xabsl::Action::getDecimalOutputSymbolValue (   )  const   Returns the last symbol value, if a decimal output symbol is to be assigned, 0 otherwise. Definition at line 324 of file XabslAction.cpp. References xabsl::ActionDecimalOutputSymbol::decimalOutputSymbolValue. bool xabsl::Action::getBooleanOutputSymbolValue (   )  const   Returns the last symbol value, if a boolean output symbol is to be assigned, 0 otherwise. Definition at line 332 of file XabslAction.cpp. References xabsl::ActionBooleanOutputSymbol::booleanOutputSymbolValue. int xabsl::Action::getEnumeratedOutputSymbolValue (   )  const   Returns the last symbol value, if an enumerated output symbol is to be assigned, 0 otherwise. Definition at line 340 of file XabslAction.cpp. References xabsl::ActionEnumeratedOutputSymbol::enumeratedOutputSymbolValue. Member Data Documentation const unsigned& xabsl::Action::time [protected]   The system time in ms. Definition at line 120 of file XabslAction.h. The documentation for this class was generated from the following files: XabslAction.h XabslAction.cpp Up | Main Page | Generated at Wed Aug 19 17:32:29 2009.
Copyright 2002 - 2009 by the XABSL developer team. See the licence for details.