mermaid::support::activeobject::Task Class Reference

Task base class. More...

#include <Task.hpp>

Inheritance diagram for mermaid::support::activeobject::Task:

[legend]

Collaboration diagram for mermaid::support::activeobject::Task:

[legend]

List of all members.

Public Member Functions
void	cancelRepeat ()
Time	getScheduledTime ()
	Scheduled time getter.
bool	hasRepeatScheduling ()
void	incrementScheduledTimeForRepeat ()
bool	isOkToRun ()
virtual void	run ()
	Method to run the Task.
	Task (Time scheduledTime=Time::getCurrentTime(), bool repeatScheduling=false, float repeatFrequency=0.0)
	Task constructor. scheduledTime Time at which Task should be executed repeatScheduling If true, the Task will be rescheduled after it has completed its execution. repeatFrequency Defines the frequency at which the Task should execute.

---

Detailed Description

Task base class.

Author:

Marco Barbosa + Nelson Ramos

Definition at line 51 of file Task.hpp.

---

Constructor & Destructor Documentation

Task::Task	(	Time	scheduledTime = Time::getCurrentTime(),
		bool	repeatScheduling = false,
		float	repeatFrequency = 0.0
	)

Task constructor. scheduledTime Time at which Task should be executed repeatScheduling If true, the Task will be rescheduled after it has completed its execution. repeatFrequency Defines the frequency at which the Task should execute.

Author:

Marco Barbosa + Nelson Ramos

Definition at line 45 of file Task.cpp.

---

Member Function Documentation

Time Task::getScheduledTime

(

)

Scheduled time getter.

Returns:

Time that Task is scheduled to run

Author:

Marco Barbosa + Nelson Ramos

Definition at line 67 of file Task.cpp.

void Task::run

(

)

[virtual]

Method to run the Task.

Author:

Marco Barbosa + Nelson Ramos

Todo:

Make this a pure virtual method

Reimplemented in mermaid::support::communication::YarpDataFeedReconnectTask, mermaid::support::communication::YarpServiceReplyConversionTask, mermaid::support::communication::YarpServiceRequestConversionTask, mermaid::support::io::AddStreamReaderTask, mermaid::support::io::AddStreamWriterTask, mermaid::support::io::CloseTask, mermaid::support::io::IOThreadUpdateTask, mermaid::support::io::StreamReadReplyTask, mermaid::support::io::StreamWriteReplyTask, mermaid::support::io::WriteTask, mermaid::support::service::ServiceBuildTask< SERVICE_TYPE >, mermaid::support::service::ServiceDataFeedDeliveryTask, mermaid::support::service::ServiceReplyDeliveryTask, mermaid::support::service::ServiceRequestDeliveryTask, mermaid::support::service::ServiceUpdateTask, mermaid::support::unitgenerator::ControlUnitServiceBuildTask< SERVICE_TYPE >, and mermaid::support::unitgenerator::UnitServiceBuildTask< SERVICE_TYPE >.

Definition at line 62 of file Task.cpp.