makVrf::DtVrfCurrentTaskManager Class Reference

Inheritance diagram for makVrf::DtVrfCurrentTaskManager:

Classes
struct	TaskInformation

Public Types
typedef DtBoost::shared_ptr < DtSimTask >	DtSimTaskSharedPtr
typedef std::vector < DtSimTaskMessageType >	Conflicting
typedef std::vector < TaskInformation >	EntityTaskInformation
typedef boost::function< void(std::string, const EntityTaskInformation &)>	DtRequestTaskCallbackFcn
	Request current tasks.

Public Member Functions
	DtVrfCurrentTaskManager (makVrv::DtDe &)
virtual	~DtVrfCurrentTaskManager ()
virtual void	subscribeForTaskInformation (const makVrv::DtUniqueID &simId)
virtual void	unsubscribeForTaskInformation (const makVrv::DtUniqueID &simId, bool all=false)
virtual void	requestCurrentTasksFor (const makVrv::DtUniqueID &simId, DtRequestTaskCallbackFcn)
virtual void	requestCurrentTasksFor (const std::vector< makVrv::DtUniqueID > &simIds)
	Will send off the allRequestsReceived when all currenttask messages are received.
virtual void	requestCurrentTasksFor (const std::vector< makVrv::DtSimEntry * > &)
virtual void	defaultReceivedTaskCallback (std::string, const EntityTaskInformation &)
	Callback used when requesting tasks for multiple objects.
virtual const EntityTaskInformation *	tasksFor (const makVrv::DtUniqueID &simId) const
	Returns the current tasks assigned to the entity.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfCurrentTaskManager &	instance (makVrv::DtDe &de)
	Returns instance of the DtVrfResourceManager.

Public Attributes
boost::signal< void(const std::string &entityName)>	signal_currentTaskChanged
boost::signal< void()>	signal_allRequestsReceived
	When all immediately requested tasks are received (via the requestCurrentTasksFor) this signal is sent out.

Protected Types
typedef std::pair < EntityTaskInformation, int >	EntityTasks
typedef std::map < makVrv::DtUniqueID, EntityTasks >	DtEntityTaskMap
typedef std::vector < DtRequestTaskCallbackFcn >	DtRequestCallbackVector
typedef std::map < makVrv::DtUniqueID, DtRequestCallbackVector >	DtRequestCallbackMap

Protected Member Functions
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &entry)
virtual void	processEntityCurrentTaskCallback (const DtVrfObjectMessage *msg)
virtual makVrv::DtUniqueID	isMonitoring (const std::string &e) const
virtual makVrv::DtUniqueID	isRequesting (const std::string &e) const
virtual void	convertTaskList (const DtCurrentTasksAdminContent::DtTaskList &, EntityTaskInformation &) const
	Converts task list to internal data representation.
virtual TaskInformation	convertDataToTaskInformation (const DtCurrentTaskData &data) const
	Converts data from the network to internal task information srtucture.
virtual void	convertMessageToInformation (const DtCurrentTasksAdminContent *, EntityTaskInformation &) const
	Converts the sim task message to the information structure.

Protected Attributes
makVrv::DtDe &	myDe
DtEntityTaskMap	myTasks
DtRequestCallbackMap	myTaskRequestCallbacks

Member Typedef Documentation

typedef DtBoost::shared_ptr<DtSimTask> makVrf::DtVrfCurrentTaskManager::DtSimTaskSharedPtr

typedef std::vector<DtSimTaskMessageType> makVrf::DtVrfCurrentTaskManager::Conflicting

typedef std::vector<TaskInformation> makVrf::DtVrfCurrentTaskManager::EntityTaskInformation

typedef boost::function<void (std::string, const EntityTaskInformation&)> makVrf::DtVrfCurrentTaskManager::DtRequestTaskCallbackFcn

Request current tasks.

Will return a structure, that, when released will also free memory for tasks, so, if you wish to keep a copy of the tasks, clone the tasks that come back

typedef std::pair<EntityTaskInformation, int> makVrf::DtVrfCurrentTaskManager::EntityTasks

protected

typedef std::map<makVrv::DtUniqueID, EntityTasks> makVrf::DtVrfCurrentTaskManager::DtEntityTaskMap

protected

typedef std::vector<DtRequestTaskCallbackFcn> makVrf::DtVrfCurrentTaskManager::DtRequestCallbackVector

protected

typedef std::map<makVrv::DtUniqueID, DtRequestCallbackVector> makVrf::DtVrfCurrentTaskManager::DtRequestCallbackMap

protected

Constructor & Destructor Documentation

makVrf::DtVrfCurrentTaskManager::DtVrfCurrentTaskManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfCurrentTaskManager::~DtVrfCurrentTaskManager ( )

virtual

Member Function Documentation

static DtVrfCurrentTaskManager& makVrf::DtVrfCurrentTaskManager::instance ( makVrv::DtDe &  de )

static

Returns instance of the DtVrfResourceManager.

virtual void makVrf::DtVrfCurrentTaskManager::subscribeForTaskInformation ( const makVrv::DtUniqueID &  simId )

virtual

virtual void makVrf::DtVrfCurrentTaskManager::unsubscribeForTaskInformation ( const makVrv::DtUniqueID &  simId, bool  all = false  )

virtual

virtual void makVrf::DtVrfCurrentTaskManager::requestCurrentTasksFor ( const makVrv::DtUniqueID &  simId, DtRequestTaskCallbackFcn    )

virtual

virtual void makVrf::DtVrfCurrentTaskManager::requestCurrentTasksFor ( const std::vector< makVrv::DtUniqueID > &  simIds )

virtual

Will send off the allRequestsReceived when all currenttask messages are received.

virtual void makVrf::DtVrfCurrentTaskManager::requestCurrentTasksFor ( const std::vector< makVrv::DtSimEntry * > &  )

virtual

virtual void makVrf::DtVrfCurrentTaskManager::defaultReceivedTaskCallback ( std::string  , const EntityTaskInformation &    )

virtual

Callback used when requesting tasks for multiple objects.

virtual const EntityTaskInformation* makVrf::DtVrfCurrentTaskManager::tasksFor ( const makVrv::DtUniqueID &  simId ) const

virtual

Returns the current tasks assigned to the entity.

Do not free information in list as it is maintained by this class

virtual void makVrf::DtVrfCurrentTaskManager::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry &  entry )

protectedvirtual

virtual void makVrf::DtVrfCurrentTaskManager::processEntityCurrentTaskCallback ( const DtVrfObjectMessage *  msg )

protectedvirtual

virtual makVrv::DtUniqueID makVrf::DtVrfCurrentTaskManager::isMonitoring ( const std::string &  e ) const

protectedvirtual

virtual makVrv::DtUniqueID makVrf::DtVrfCurrentTaskManager::isRequesting ( const std::string &  e ) const

protectedvirtual

virtual void makVrf::DtVrfCurrentTaskManager::convertTaskList ( const DtCurrentTasksAdminContent::DtTaskList &  , EntityTaskInformation &    ) const

protectedvirtual

Converts task list to internal data representation.

virtual TaskInformation makVrf::DtVrfCurrentTaskManager::convertDataToTaskInformation ( const DtCurrentTaskData &  data ) const

protectedvirtual

Converts data from the network to internal task information srtucture.

virtual void makVrf::DtVrfCurrentTaskManager::convertMessageToInformation ( const DtCurrentTasksAdminContent *  , EntityTaskInformation &    ) const

protectedvirtual

Converts the sim task message to the information structure.

Member Data Documentation

boost::signal<void (const std::string& entityName)> makVrf::DtVrfCurrentTaskManager::signal_currentTaskChanged

boost::signal<void ()> makVrf::DtVrfCurrentTaskManager::signal_allRequestsReceived

When all immediately requested tasks are received (via the requestCurrentTasksFor) this signal is sent out.

makVrv::DtDe& makVrf::DtVrfCurrentTaskManager::myDe

protected

DtEntityTaskMap makVrf::DtVrfCurrentTaskManager::myTasks

protected

DtRequestCallbackMap makVrf::DtVrfCurrentTaskManager::myTaskRequestCallbacks

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/vrfCurrentTaskManager.h