Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
orxonox::CommandNotification Class Reference

This class implements a method of displaying a Notification with information to an input command and the key the command is mapped to. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/notifications/dispatchers/CommandNotification.h>

Inheritance diagram for orxonox::CommandNotification:
orxonox::NotificationDispatcher orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Listable orxonox::Identifiable orxonox::Identifiable

Public Member Functions

 CommandNotification (Context *context)
 Default Constructor. More...
 
virtual ~CommandNotification ()
 Destructor. More...
 
const std::string & getCommand (void)
 Get the command, whose key is displayed. More...
 
const std::string & getPostMessage (void)
 Get the postMessage, the last part of the displayed message. More...
 
const std::string & getPreMessage (void)
 Get the preMessage, the first part of the displayed message. More...
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 Method for creating a CommandNotification object through XML. More...
 
- Public Member Functions inherited from orxonox::NotificationDispatcher
 NotificationDispatcher (Context *context)
 Default constructor. Initializes the object. More...
 
virtual ~NotificationDispatcher ()
 Destructor. More...
 
void broadcast (void)
 Broadcasts a specific Notification. More...
 
void broadcastHelper (void)
 Helper function for broadcast. More...
 
void dispatch (unsigned int clientId)
 Dispatches a specific Notification to a given client. More...
 
const std::string & getSender (void) const
 Get the sender of the Notification dispatched by this NotificationDispatcher. More...
 
bool isBroadcasting (void) const
 Check whether the NotificationDispatcher is set to broadcast. More...
 
void setBroadcasting (bool v)
 Set the NotificationDispatcher to broadcast. More...
 
void setSender (const std::string &sender)
 Set the sender of the Notification dispatched by this NotificationDispatcher. More...
 
bool trigger (bool triggered, BaseObject *trigger)
 Is called when the NotificationDispatcher is triggered. More...
 
virtual void XMLEventPort (Element &xmlelement, XMLPort::Mode mode) override
 Defines the possible event states of this object and parses eventsources from an XML file. More...
 
- Public Member Functions inherited from orxonox::BaseObject
 BaseObject (Context *context)
 Constructor: Registers the object in the BaseObject-list. More...
 
virtual ~BaseObject ()
 Destructor. More...
 
void addEventListener (BaseObject *listener)
 Adds an object which listens to the events of this object. More...
 
void addEventSource (BaseObject *source, const std::string &state)
 Adds a new event source for a specific state. More...
 
void addTemplate (const std::string &name)
 Adds a Template to the object. More...
 
void addTemplate (Template *temp)
 Adds a Template to the object. More...
 
virtual void changedActivity ()
 This function gets called if the activity of the object changes. More...
 
virtual void changedMainStateName ()
 This function gets called if the main state name of the object changes. More...
 
virtual void changedName ()
 This function gets called if the name of the object changes. More...
 
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes. More...
 
void fireEvent (const std::string &name="")
 Fires an event (without a state). More...
 
void fireEvent (bool activate, const std::string &name="")
 Fires an event which activates or deactivates a state. More...
 
void fireEvent (bool activate, BaseObject *originator, const std::string &name="")
 Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...
 
void fireEvent (Event &event)
 Fires an event, using the Event struct. More...
 
BaseObjectgetCreator () const
 
BaseObjectgetEventListener (unsigned int index) const
 Returns an event listener with a given index. More...
 
BaseObjectgetEventSource (unsigned int index, const std::string &state) const
 Returns an eventsource with a given index. More...
 
const XMLFilegetFile () const
 Returns a pointer to the XMLFile that loaded this object. More...
 
const std::string & getFilename () const
 Returns the levelfile that loaded this object. More...
 
GametypegetGametype () const
 
LevelgetLevel () const
 
const std::string & getLoaderIndentation () const
 Returns the indentation of the debug output in the Loader. More...
 
const std::string & getMainStateName () const
 Returns the name of the main state. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
NamespacegetNamespace () const
 
const std::string & getOldName () const
 Returns the old name of the object. More...
 
ScenegetScene () const
 
virtual uint32_t getSceneID () const
 
const std::set< Template * > & getTemplates () const
 Returns the set of all aplied templates. More...
 
const mboolisActive () const
 Returns the state of the objects activity. More...
 
bool isInitialized () const
 Returns if the object was initialized (passed the object registration). More...
 
const mboolisVisible () const
 Returns the state of the objects visibility. More...
 
virtual void processEvent (Event &event)
 Processing an event by calling the right main state. More...
 
void removeEventSource (BaseObject *source)
 Removes an eventsource (but doesn't unregister itself at the source). More...
 
void setActive (bool bActive)
 Sets the state of the objects activity. More...
 
void setCreator (BaseObject *creator)
 
void setFile (const XMLFile *file)
 Sets a pointer to the xml file that loaded this object. More...
 
void setGametype (const StrongOrWeakPtr< Gametype > &gametype)
 
void setLevel (const StrongOrWeakPtr< Level > &level)
 
void setLoaderIndentation (const std::string &indentation)
 Sets the indentation of the debug output in the Loader. More...
 
void setMainState (bool state)
 Sets the main state of the object to a given boolean value. More...
 
void setMainStateName (const std::string &name)
 Sets the name of the main state (used for event reactions). More...
 
void setName (const std::string &name)
 Sets the name of the object. More...
 
void setNamespace (const StrongOrWeakPtr< Namespace > &ns)
 
void setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)
 
void setVisible (bool bVisible)
 Sets the state of the objects visibility. More...
 
- Public Member Functions inherited from orxonox::OrxonoxClass
 OrxonoxClass ()
 
OrxonoxClassoperator= (const OrxonoxClass &)=default
 
- Public Member Functions inherited from orxonox::Configurable
 Configurable ()
 
void setConfigValues ()
 Function to collect the SetConfigValue-macro calls. More...
 
- Public Member Functions inherited from orxonox::Listable
 Listable ()
 Constructor: Allocates space in the element list. More...
 
 Listable (Context *context)
 Constructor: Allocates space in the element list and assigns the context. More...
 
virtual ~Listable ()
 Destructor: Removes the object from the object-lists. More...
 
ContextgetContext () const
 
void setContext (Context *context)
 Changes the context. More...
 
void unregisterObject ()
 Removes this object from the object-lists. More...
 
- Public Member Functions inherited from orxonox::Identifiable
 Identifiable ()
 Constructor: Sets the default values. More...
 
virtual ~Identifiable ()
 
ORX_FORCEINLINE voidgetDerivedPointer (unsigned int classID)
 Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
 
template<class T >
ORX_FORCEINLINE T * getDerivedPointer (unsigned int classID)
 Version of getDerivedPointer with template. More...
 
template<class T >
ORX_FORCEINLINE const T * getDerivedPointer (unsigned int classID) const
 Const version of getDerivedPointer with template. More...
 
IdentifiergetIdentifier () const
 Returns the Identifier of the object. More...
 
bool isA (const Identifier *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
template<class B >
bool isA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isA (const Identifiable *object)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isChildOf (const Identifier *identifier)
 Returns true if the object's class is a child of the given type. More...
 
template<class B >
bool isChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a child of the given type. More...
 
bool isChildOf (const Identifiable *object)
 Returns true if the object's class is a child of the given type. More...
 
bool isDirectChildOf (const Identifier *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
template<class B >
bool isDirectChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectChildOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectParentOf (const Identifier *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
template<class B >
bool isDirectParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
bool isDirectParentOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isExactlyA (const Identifier *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
template<class B >
bool isExactlyA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
bool isExactlyA (const Identifiable *object)
 Returns true if the object's class is exactly of the given type. More...
 
bool isParentOf (const Identifier *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
template<class B >
bool isParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
bool isParentOf (const Identifiable *object)
 Returns true if the object's class is a parent of the given type. More...
 
- Public Member Functions inherited from orxonox::Destroyable
 Destroyable ()
 Constructor: Sets the default values. More...
 
virtual ~Destroyable ()
 Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...
 
void destroy ()
 Deletes the object if no strong pointers point to this object. More...
 
void destroyLater ()
 Works like destroy() but doesn't destroy the object until the current tick has ended. More...
 
unsigned int getReferenceCount () const
 Returns the number of strong pointers that point to this object. More...
 
- Public Member Functions inherited from orxonox::Synchronisable
virtual ~Synchronisable ()
 Destructor: Delete all callback objects and remove objectID_ from the objectMap_. More...
 
uint32_t getClassID () const
 
unsigned int getContextID () const
 
uint32_t getNrOfVariables ()
 
uint32_t getObjectID () const
 
unsigned int getPriority () const
 
uint8_t getSyncMode () const
 
uint32_t getVarSize (VariableID ID)
 
template<>
_NetworkExport void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
template<>
void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
void setSyncMode (uint8_t mode)
 This function sets the synchronisation mode of the object If set to 0x0 variables will not be synchronised at all If set to 0x1 variables will only be synchronised to the client If set to 0x2 variables will only be synchronised to the server If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) More...
 
template<>
_NetworkExport void unregisterVariable (std::string &variable)
 
template<>
void unregisterVariable (std::string &variable)
 
- Public Member Functions inherited from orxonox::OrxonoxInterface
 OrxonoxInterface ()
 

Protected Member Functions

virtual const std::string & createNotificationMessage (void)
 Composes the Notification of the preMessage the name of the key the command is mapped to and the postMessage. More...
 
- Protected Member Functions inherited from orxonox::NotificationDispatcher
void registerVariables (void)
 Register some variables for synchronisation. More...
 
- Protected Member Functions inherited from orxonox::BaseObject
void addEventState (const std::string &name, EventState *container)
 Adds a new event-state to the object. More...
 
EventStategetEventState (const std::string &name) const
 Returns the event-state with the given name. More...
 
- Protected Member Functions inherited from orxonox::Destroyable
virtual void preDestroy ()
 This virtual function is called if destroy() is called and no StrongPtr points to this object. More...
 
- Protected Member Functions inherited from orxonox::Synchronisable
 Synchronisable (Context *context)
 Constructor: Initializes all Variables and sets the right objectID_. More...
 
uint32_t findContextID (Context *context)
 Returns the id of the context. More...
 
template<class T >
void registerVariable (T &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
template<class T >
void registerVariable (std::set< T > &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
void setPriority (unsigned int freq)
 
template<class T >
void unregisterVariable (T &var)
 

Private Member Functions

void registerVariables (void)
 Register some variables for synchronisation. More...
 
void setCommand (const std::string &command)
 Set the command, whose key is displayed. More...
 
void setPostMessage (const std::string &message)
 Set the postMessage, the last part of the displayed message. More...
 
void setPreMessage (const std::string &message)
 Set the preMessage, the first part of the displayed message. More...
 

Private Attributes

std::string command_
 The name of the command. More...
 
std::string postMessage_
 The last part of the displayed message. More...
 
std::string preMessage_
 The first part of the displayed message. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from orxonox::BaseObject
static void loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject *object, Identifier *identifier)
 Manually loads all event states, even if the class doesn't officially support them. More...
 
- Static Public Member Functions inherited from orxonox::Synchronisable
static bool deleteObject (uint32_t objectID_)
 Finds and deletes the Synchronisable with the appropriate objectID_. More...
 
static Synchronisablefabricate (uint8_t *&mem, uint8_t mode=0x0)
 This function fabricated a new synchrnisable (and children of it), sets calls updateData and create After calling this function the mem pointer will be increased by the size of the needed data. More...
 
static unsigned int getNumberOfDeletedObject ()
 
static SynchronisablegetSynchronisable (uint32_t objectID_)
 This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable. More...
 
static uint32_t popDeletedObject ()
 
static void setClient (bool b)
 This function sets the internal mode for synchronisation. More...
 
- Protected Attributes inherited from orxonox::NotificationDispatcher
bool bBroadcast_
 Whether the NotificationDispatcher is broadcasting. More...
 
std::string sender_
 The name of the sender of the Notification dispatched by this NotificationDispatcher. More...
 
- Protected Attributes inherited from orxonox::BaseObject
mbool bActive_
 True = the object is active. More...
 
mbool bVisible_
 True = the object is visible. More...
 
FunctorPtr mainStateFunctor_
 
std::string mainStateName_
 
std::string name_
 The name of the object. More...
 
std::set< std::string > networkTemplateNames_
 
std::string oldName_
 The old name of the object. More...
 

Detailed Description

This class implements a method of displaying a Notification with information to an input command and the key the command is mapped to.

The message that is displayed is a string made out of the concatenation of the preMessage, the key the specified command is mapped to and the postMessage.

In use it would like this:

<CommandNotification preMessage="Please press " command="someCommand" postMessage=" to do something." sender="me">
<events>
<PlayerTrigger />
</events>

Upon being triggered this would display the Notification "Please press {the binding of the specified command} to do something". For more information on what can be used for

<PlayerTrigger />

see the NotificationDispatcher documentation.

Author
Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::CommandNotification::CommandNotification ( Context context)

Default Constructor.

Registers the object and initializes variables.

orxonox::CommandNotification::~CommandNotification ( )
virtual

Destructor.

Member Function Documentation

const std::string & orxonox::CommandNotification::createNotificationMessage ( void  )
protectedvirtual

Composes the Notification of the preMessage the name of the key the command is mapped to and the postMessage.

Returns
Returns the message to be sent in the Notification.

Reimplemented from orxonox::NotificationDispatcher.

const std::string& orxonox::CommandNotification::getCommand ( void  )
inline

Get the command, whose key is displayed.

Returns
Returns the name of the command.
const std::string& orxonox::CommandNotification::getPostMessage ( void  )
inline

Get the postMessage, the last part of the displayed message.

Returns
Returns the postMessage.
const std::string& orxonox::CommandNotification::getPreMessage ( void  )
inline

Get the preMessage, the first part of the displayed message.

Returns
Returns the preMessage.
void orxonox::CommandNotification::registerVariables ( void  )
private

Register some variables for synchronisation.

void orxonox::CommandNotification::setCommand ( const std::string &  command)
inlineprivate

Set the command, whose key is displayed.

Parameters
commandThe name of the command.
void orxonox::CommandNotification::setPostMessage ( const std::string &  message)
inlineprivate

Set the postMessage, the last part of the displayed message.

Parameters
messageThe postMessage.
void orxonox::CommandNotification::setPreMessage ( const std::string &  message)
inlineprivate

Set the preMessage, the first part of the displayed message.

Parameters
messageThe preMessage.
void orxonox::CommandNotification::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
)
virtual

Method for creating a CommandNotification object through XML.

Method for creating a NotificationDispatcher object through XML.

Reimplemented from orxonox::NotificationDispatcher.

Member Data Documentation

std::string orxonox::CommandNotification::command_
private

The name of the command.

std::string orxonox::CommandNotification::postMessage_
private

The last part of the displayed message.

std::string orxonox::CommandNotification::preMessage_
private

The first part of the displayed message.


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