AIM
 All Classes Functions Variables Typedefs Enumerations
Public Member Functions | List of all members
ExampleModule Class Reference

#include <ExampleModule.h>

Inheritance diagram for ExampleModule:
AIM

Public Member Functions

 ExampleModule (std::string name="example_module")
 
void doTick ()
 
- Public Member Functions inherited from AIM
 AIM (std::string name="")
 
 AIM (const AIM &other)
 
AIM & operator= (const AIM &rhs)
 
virtual void addDataSubscriber (const std::string &key, AIM *subscriber)
 
virtual void removeDataSubscriber (const std::string &key)
 
virtual AIMValue setProperty (const std::string &key, AIMValue value)
 
virtual AIMValue getProperty (std::string key) const
 
virtual void sendData ()
 
virtual void addData (const AIMData &data)
 
virtual std::string exportProperties ()
 
virtual std::vector< std::pair
< std::string, AIMValue > > 		getOutputData (bool clear_output=false)
 
virtual std::vector< std::pair
< std::string, AIMValue > > 		getInputData (bool clear_input=false)
 
virtual AIM * getDataSubscriber (std::string subscriber)
 
virtual const std::map
< std::string, AIMValue > & 		getProperties ()
 
virtual std::string getName () const
 
virtual std::vector< AIMValue > getRequirements () const
 
virtual bool requirementsAreUpdated (bool reset=true) const
 
virtual void setProperties (const std::map< std::string, AIMValue > &properties)
 

Additional Inherited Members

- Public Types inherited from AIM
typedef std::pair< std::string,
AIMValue > 		AIMData
 
typedef std::queue< AIMData > AIMDataQueue
 
typedef std::queue< AIMValue > AIMValueQueue
 
typedef std::map< std::string,
AIMValueQueue > 		InputDataQueue
 
- Static Public Attributes inherited from AIM
static const std::string VERSION = AIM_VERSION
 
- Protected Member Functions inherited from AIM
void setDataSubscribers (const std::map< std::string, AIM * > &subscribers)
 
void setInputDataQueue (const InputDataQueue &inputDataQueue)
 
void setOutputDataQueue (const AIMDataQueue &outputDataQueue)
 
- Protected Attributes inherited from AIM
std::string name
 
std::vector< AIMValue > requirements
 
bool requirementsUpdated
 
std::map< std::string, AIM * > dataSubscribers
 
std::map< std::string, AIMValue > properties
 
InputDataQueue inputDataQueue
 
AIMDataQueue outputDataQueue
 

Detailed Description

ExampleModule.h

Created on: Feb 8, 2013 Author: Ted Schmidt

This is an example class for demonstrating an AIM implementation.
This module checks whether the input value is an number or string and adds a value to this.

Member Function Documentation

void ExampleModule::doTick ( )
virtual

Do an AIM tick

This method is called to tick the AI-module to do its processing. During this tick the AI module grabs it's input data, does its processing, and sends the data to its data receivers. This method can be used in combination with AIM priorities, to streamline the data flow and timers for timed AI modules.

Reimplemented from AIM.

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