A wrapper for a Command function with parameter. More...

#include <ParametrisedWrappingCommand.h>

Inheritance diagram for ParametrisedWrappingCommand< T, S >:

Collaboration diagram for ParametrisedWrappingCommand< T, S >:

Public Types
typedef SUMOTime(T::*	Operation) (SUMOTime, S)
	Type of the function to execute. (with parameter)

Public Member Functions
void	deschedule ()
	Marks this Command as being descheduled.

bool	isDescheduled ()
	whether this command has been descheduled

	ParametrisedWrappingCommand (T *receiver, const S &param, Operation operation)
	Constructor.

virtual SUMOTime	shiftTime (SUMOTime, SUMOTime, SUMOTime)
	Reschedule or deschedule the command when quick-loading state.

	~ParametrisedWrappingCommand ()
	Destructor.

Derived from Command
SUMOTime	execute (SUMOTime currentTime)
	Executes the command.

Data Fields
int	priority = 0

Private Attributes
bool	myAmDescheduledByParent
	Whether this command was descheduled (is invalid) and shall not be executed.

Operation	myOperation
	The object's operation to perform.

S	myParameter
	The parameter.

T *	myReceiver
	The object the action is directed to.

Detailed Description

template<class T, class S>
class ParametrisedWrappingCommand< T, S >

A wrapper for a Command function with parameter.

See also: WrappingCommand.h

Definition at line 36 of file ParametrisedWrappingCommand.h.

Member Typedef Documentation

◆ Operation

template<class T , class S >

typedef SUMOTime(T::* ParametrisedWrappingCommand< T, S >::Operation) (SUMOTime, S)

Type of the function to execute. (with parameter)

Definition at line 40 of file ParametrisedWrappingCommand.h.

Constructor & Destructor Documentation

◆ ParametrisedWrappingCommand()

template<class T , class S >

ParametrisedWrappingCommand< T, S >::ParametrisedWrappingCommand	(	T *	receiver,
		const S &	param,
		Operation	operation
	)

inline

Constructor.

Parameters

[in]	receiver	Pointer to object of type T that will receive a call to one of its methods.
[in]	parameter	The methods parameter (must be copy-constructable)
[in]	operation	The objects' method that will be called on execute()

Definition at line 51 of file ParametrisedWrappingCommand.h.

◆ ~ParametrisedWrappingCommand()

template<class T , class S >

ParametrisedWrappingCommand< T, S >::~ParametrisedWrappingCommand ( )

inline

Destructor.

Definition at line 57 of file ParametrisedWrappingCommand.h.

Member Function Documentation

◆ deschedule()

template<class T , class S >

void ParametrisedWrappingCommand< T, S >::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 65 of file ParametrisedWrappingCommand.h.

References ParametrisedWrappingCommand< T, S >::myAmDescheduledByParent.

◆ execute()

template<class T , class S >

SUMOTime ParametrisedWrappingCommand< T, S >::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 87 of file ParametrisedWrappingCommand.h.

References ParametrisedWrappingCommand< T, S >::myAmDescheduledByParent, ParametrisedWrappingCommand< T, S >::myOperation, ParametrisedWrappingCommand< T, S >::myParameter, and ParametrisedWrappingCommand< T, S >::myReceiver.

◆ isDescheduled()

template<class T , class S >

bool ParametrisedWrappingCommand< T, S >::isDescheduled ( )

inline

whether this command has been descheduled

Definition at line 70 of file ParametrisedWrappingCommand.h.

References ParametrisedWrappingCommand< T, S >::myAmDescheduledByParent.

◆ shiftTime()

virtual SUMOTime Command::shiftTime	(	SUMOTime	,
		SUMOTime	,
		SUMOTime
	)

inlinevirtualinherited

Reschedule or deschedule the command when quick-loading state.

The implementations should return -1 if the command shall not be re-scheduled, or a value >= 0 that describe the new time at which the command shall be executed again.

Parameters

[in]	currentTime	The current simulation time
[in]	execTime	The time at which the command would have been executed
[in]	newTime	The simulation time at which the simulation is restarted