StaticCommand< T > Class Template Reference

A wrapper for a Command function. More...

#include <StaticCommand.h>

Inheritance diagram for StaticCommand< T >:

Collaboration diagram for StaticCommand< T >:

Public Types
typedef SUMOTime(*	Operation) (SUMOTime)
	Type of the function to execute. More...

Public Member Functions
void	deschedule ()
	Marks this Command as being descheduled. More...
	StaticCommand (Operation operation)
	Constructor. More...
	~StaticCommand ()
	Destructor. More...
Derived from Command
SUMOTime	execute (SUMOTime currentTime)
	Executes the command. More...

Private Attributes
bool	myAmDescheduledByParent
	Whether this command was descheduled (is invalid) and shall not be executed. More...
Operation	myOperation
	The object's operation to perform. More...

Detailed Description

template<class T>
class StaticCommand< T >

A wrapper for a Command function.

See also

Design Patterns, Gamma et al.

Command

MSEventControl

Definition at line 49 of file StaticCommand.h.

Member Typedef Documentation

template<class T >

typedef SUMOTime(* StaticCommand< T >::Operation) (SUMOTime)

Type of the function to execute.

Definition at line 52 of file StaticCommand.h.

Constructor & Destructor Documentation

template<class T >

StaticCommand< T >::StaticCommand ( Operation  operation )

inline

Constructor.

Parameters

[in]	receiver	Pointer to object of type T that will receive a call to one of it's methods.
[in]	operation	The objects' method that will be called on execute()

Definition at line 62 of file StaticCommand.h.

template<class T >

StaticCommand< T >::~StaticCommand ( )

inline

Destructor.

Definition at line 67 of file StaticCommand.h.

Member Function Documentation

template<class T >

void StaticCommand< T >::deschedule ( )

inline

Marks this Command as being descheduled.

A simple boolean marker ("myAmDescheduledByParent") is set which prevents this command from being executed.

Definition at line 75 of file StaticCommand.h.

References StaticCommand< T >::myAmDescheduledByParent.

template<class T >

SUMOTime StaticCommand< T >::execute ( SUMOTime  currentTime )

inlinevirtual

Executes the command.

If the command is not descheduled, the stored method of the stored instance is called.

Parameters

[in]

currentTime

The current simulation time

Returns

The time after which the command shall be executed again, 0 if this command shall be descheduled.

Exceptions

ProcessError

Derived actions may throw this exception

Implements Command.

Definition at line 93 of file StaticCommand.h.

References StaticCommand< T >::myAmDescheduledByParent, and StaticCommand< T >::myOperation.

Field Documentation

template<class T >

bool StaticCommand< T >::myAmDescheduledByParent

private

Whether this command was descheduled (is invalid) and shall not be executed.

Definition at line 109 of file StaticCommand.h.

Referenced by StaticCommand< T >::deschedule(), and StaticCommand< T >::execute().

template<class T >

Operation StaticCommand< T >::myOperation

private

The object's operation to perform.

Definition at line 106 of file StaticCommand.h.

Referenced by StaticCommand< T >::execute().

---

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

• StaticCommand.h