vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vrecko::AbilityDispatcher Class Reference

used for managing abilities in an EnvironmentObject and for distributing received messages to a relevant abilities More...

#include <Ability.h>

Inheritance diagram for vrecko::AbilityDispatcher:
vrecko::BaseClass

Public Types

typedef std::map< std::string,
Ability * > 
AbilityMap
 
- Public Types inherited from vrecko::BaseClass
enum  NotificationTypes {
  NOTIFICATION_DELETE_CLASS = 1, NOTIFICATION_EO_REGISTERING = 2, NOTIFICATION_EO_UNREGISTERING = 4, NOTIFICATION_PROGRAM_TERMINATION = 8,
  NOTIFICATION_ALL = 0xFFFFFFFF
}
 

Public Member Functions

 AbilityDispatcher ()
 
 ~AbilityDispatcher ()
 
void addAbility (Ability *pAbility)
 
void removeAbility (Ability *pAbility)
 
void removeAllAbilities ()
 
AbilitygetAbility (const std::string &ab_id)
 
AbilityMapgetAbilityMap (void)
 
AbilitygetAbilityWithInput (const std::string &input_name)
 
AbilitygetAbilityWithOutput (const std::string &output_name)
 
- Public Member Functions inherited from vrecko::BaseClass
 BaseClass (const char *startingSenderString)
 The main constructor. More...
 
 BaseClass (BaseClass &bc)
 Copy constructor. Probably not really used. More...
 
virtual ~BaseClass ()
 Destructor. More...
 
virtual bool initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
 Core initialization. More...
 
virtual bool initializeFromString (const char *xmlString)
 Helper method that allows to initialize ability from a XML-formatted string. More...
 
virtual void update (void)
 This method is called periodically in case this instance is registered in Scheduler. More...
 
virtual
XERCES_CPP_NAMESPACE_QUALIFIER
DOMNode
saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
 Save current setting into a XML node. More...
 
bool inputPresent (const std::string &name)
 Returns true if input pin (not request inputpin ) with given name is present. More...
 
bool outputPresent (const std::string &name)
 Returns true if output pin (not request output pin) with given name is present. More...
 
void addInputPin (InputPinBase *pin)
 Adds an input pin. More...
 
void removeInputPin (InputPinBase *pin)
 Removes an input pin. More...
 
void addOutputPin (OutputPinBase *pin)
 Adds an output pin. More...
 
void removeOutputPin (OutputPinBase *pin)
 Removes and output pin. More...
 
void addRequestInputPin (RequestInputPinBase *pin)
 Adds a request input pin. More...
 
void removeRequestInputPin (RequestInputPinBase *pin)
 Removes a request input pin. More...
 
void addRequestOutputPin (RequestOutputPinBase *pin)
 Adds a request output pin. More...
 
void removeRequestOutputPin (RequestOutputPinBase *pin)
 Removes a request output pin. More...
 
bool addNotification (BaseClass *receiver, unsigned long notificationTypes)
 Registers an observer that will be notified if a specific change occurs. More...
 
bool removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
 Unregisters a previously registered observer. More...
 
virtual void processEvent (const std::string &input_name, VreckoMessage *pMessage)
 Internal method for processing the events. More...
 
virtual VreckoMessageprocessRequest (const std::string &request_input_name, VreckoMessage *pMessage)
 Internal method for processing the requests. More...
 
virtual const std::string & getSenderString (void)
 Returns the sender (or receiver) identification string. More...
 
void reportError (const std::string &error)
 Print error message. More...
 
void setPriority (long int pr)
 Sets the priority. (Possible problems - read the full description for more info) More...
 
long int getPriority (void) const
 Returns current object priority. More...
 
void setAttribute (const std::string &attr_name, int attr_value)
 Sets an attribute value. More...
 
int getAttribute (const std::string &attr_name)
 Returns attribute value. More...
 
int getAttribute (const char *attr_name)
 Returns attribute value. More...
 
void deleteAttribute (const std::string &attr_name)
 Delete an attribute. More...
 
void setSceneFile (const std::string &sceneFileName)
 Set the name of the file this component was in (and possibly will be saved to). More...
 
const std::string & getSceneFile () const
 Get the name of the file this component was in. More...
 
virtual void preInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual void postInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual bool loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual bool loadXMLParameters (const char *xmlString)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
InputPinBasegetInputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 
OutputPinBasegetOutputPin (const char *strName)
 Returns pointer to an output pin with specified name. More...
 
RequestInputPinBasegetRequestInputPin (const char *strName)
 Returns pointer to an request input pin with specified name. More...
 
RequestOutputPinBasegetRequestOutputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 

Protected Attributes

std::map< std::string, Ability * > ability_map
 Map where is recorded the abilities handled in AbilityDispatcher. More...
 
AbilityMap ability_name_map
 Map where is recorded the name and pointer to abilities. More...
 
MTLock mainLock
 
- Protected Attributes inherited from vrecko::BaseClass
AttributeMap attribute
 
MTReadWriteLock attributeLock
 
std::string senderString
 
MTLock notificationsLock
 
std::vector
< NOTIFICATION_DESCRIPTION
notifications
 
long int priority
 
const std::string * sceneFile
 
PinList inputPinsList
 
PinList outputPinsList
 
PinList requestInputPinsList
 
PinList requestOutputPinsList
 

Additional Inherited Members

- Protected Types inherited from vrecko::BaseClass
typedef std::map< std::string,
int > 
AttributeMap
 Attributes. More...
 
typedef std::vector
< osg::ref_ptr< IOPinBase > > 
PinList
 
- Protected Member Functions inherited from vrecko::BaseClass
bool sendNotifications (unsigned long notificationType, void *notificationData)
 
virtual int processNotification (BaseClass *sender, unsigned long notificationType, void *notificationData)
 Process an incoming notification. More...
 
IOPinBasefindPinInList (const char *strName, PinList *pinList)
 Internal method to find a given pin in a given list. More...
 

Detailed Description

used for managing abilities in an EnvironmentObject and for distributing received messages to a relevant abilities

This class is used in the World and EnvironmentObject classes internally. Others probably won't need to use it directly, because World and EO hides all its methods and exposes theirs instead.

Warning
NOT completely THREAD SAFE yet... some main functions are ok, but getAbilityMap() might cause serious troubles if you use it wrongly.
Author
Jan Flasar
Date
2002

Member Typedef Documentation

typedef std::map<std::string, Ability*> vrecko::AbilityDispatcher::AbilityMap

Return reference to ability map.

Constructor & Destructor Documentation

AbilityDispatcher::AbilityDispatcher ( )
AbilityDispatcher::~AbilityDispatcher ( )

Member Function Documentation

void AbilityDispatcher::addAbility ( Ability pAbility)

When an ability is added to an environment object this function is called. It adds this ability to the AbilityDispatcher.

Ability * AbilityDispatcher::getAbility ( const std::string &  ab_id)

Return Ability with given ID (ability name + plugin ID).

AbilityMap& vrecko::AbilityDispatcher::getAbilityMap ( void  )
inline
Ability * AbilityDispatcher::getAbilityWithInput ( const std::string &  input_name)
Ability * AbilityDispatcher::getAbilityWithOutput ( const std::string &  output_name)
void AbilityDispatcher::removeAbility ( Ability pAbility)

It removes the ability from ability dispatcher.

void AbilityDispatcher::removeAllAbilities ( )

Member Data Documentation

std::map<std::string, Ability*> vrecko::AbilityDispatcher::ability_map
protected

Map where is recorded the abilities handled in AbilityDispatcher.

AbilityMap vrecko::AbilityDispatcher::ability_name_map
protected

Map where is recorded the name and pointer to abilities.

MTLock vrecko::AbilityDispatcher::mainLock
protected

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