The DtReactiveTaskOrganizer class will organize reactive tasks for the given group of entities. More...

Public Member Functions
	DtReactiveTaskOrganizer (makVrv::DtDe &)
	CTOR.
virtual	~DtReactiveTaskOrganizer ()
	DTOR.
virtual void	organize (const std::vector< makVrv::DtSimEntry * > &)
	Call to request entities to organize. If there is a current task organization, that will be cleared.
virtual bool	addEnabledStatesTheSame (const std::string &, bool &enabled) const
	Returns true if all the reactive tasks for the organized entities are the same enabled states are the same.
virtual bool	allPrioritiesAreTheSame (const std::string &, int &priority) const
	Returns true if all the priorities for the given reactive task are the same, and, if so, what that priority is.
virtual const std::set < std::string > &	disabledScripts () const
	Returns a list of all currently disabled scripts that are common amongst the entries.
virtual const std::set < std::string > &	commonScripts () const
	Returns a list of scripts that are common amongst the selected items.
virtual const std::set < std::string > &	enabledScripts () const
	Returns a list of all enabled scripts in common.
virtual int	maxPriority () const
	Returns the maximum priority of all items.
virtual int	maxNonMixedPriority () const
	Returns the maximum priority of those items that are non-mixed.
virtual std::vector < DtScriptedTaskVariable >	variablesFor (const std::string &) const
	Returns variables for the given script id.

Public Attributes
boost::signal< void()>	signal_organized
	When all immediately requested tasks are received (via the DtVrfCurrentTaskManager) this signal is sent out.

Protected Member Functions
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &entry)
	If an entry is about to be removed we no longer need to watch it.
virtual void	allTasksReceived ()
	Called when all tasks are received.
virtual const DtScriptedTaskTask *	scriptedTaskFor (const std::string &id, const DtVrfCurrentTaskManager::EntityTaskInformation &taskInformation) const
	Returns the scripted task matching the id in the list, else returns 0.

Protected Attributes
makVrv::DtDe &	myDe
std::vector< makVrv::DtUniqueID >	myEntries
int	myMaximumPriority
std::set< std::string >	myCommonScripts
std::set< std::string >	myEnabledScripts
std::set< std::string >	myDisabledScripts

Detailed Description

The DtReactiveTaskOrganizer class will organize reactive tasks for the given group of entities.

This organization will be able to answer a few questions about the reactive tasks contained

Constructor & Destructor Documentation

makVrf::DtReactiveTaskOrganizer::DtReactiveTaskOrganizer ( makVrv::DtDe & )

CTOR.

virtual makVrf::DtReactiveTaskOrganizer::~DtReactiveTaskOrganizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtReactiveTaskOrganizer::organize ( const std::vector< makVrv::DtSimEntry * > & )

virtual

Call to request entities to organize. If there is a current task organization, that will be cleared.

virtual bool makVrf::DtReactiveTaskOrganizer::addEnabledStatesTheSame	(	const std::string &	,
		bool &	enabled
	)		const

virtual

Returns true if all the reactive tasks for the organized entities are the same enabled states are the same.

The second flag will be true/false depending on whether or not they are all enabled or disabled

virtual bool makVrf::DtReactiveTaskOrganizer::allPrioritiesAreTheSame	(	const std::string &	,
		int &	priority
	)		const

virtual

Returns true if all the priorities for the given reactive task are the same, and, if so, what that priority is.

If the priorities are not the same, the priority returned will be the largest priority

virtual const std::set<std::string>& makVrf::DtReactiveTaskOrganizer::disabledScripts ( ) const

virtual

Returns a list of all currently disabled scripts that are common amongst the entries.

virtual const std::set<std::string>& makVrf::DtReactiveTaskOrganizer::commonScripts ( ) const

virtual

Returns a list of scripts that are common amongst the selected items.

virtual const std::set<std::string>& makVrf::DtReactiveTaskOrganizer::enabledScripts ( ) const

virtual

Returns a list of all enabled scripts in common.

virtual int makVrf::DtReactiveTaskOrganizer::maxPriority ( ) const

virtual

Returns the maximum priority of all items.

virtual int makVrf::DtReactiveTaskOrganizer::maxNonMixedPriority ( ) const

virtual

Returns the maximum priority of those items that are non-mixed.

If all mixed returns the maxPriority

virtual std::vector<DtScriptedTaskVariable> makVrf::DtReactiveTaskOrganizer::variablesFor ( const std::string & ) const

virtual

Returns variables for the given script id.

If there is more than one data element being organized the default variables for the reactive task will be returned, else the defaults for the current reactive task as discovered from the current task will be returned

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

protectedvirtual

If an entry is about to be removed we no longer need to watch it.

virtual void makVrf::DtReactiveTaskOrganizer::allTasksReceived ( )

protectedvirtual

Called when all tasks are received.

virtual const DtScriptedTaskTask* makVrf::DtReactiveTaskOrganizer::scriptedTaskFor	(	const std::string &	id,
		const DtVrfCurrentTaskManager::EntityTaskInformation &	taskInformation
	)		const

protectedvirtual

Returns the scripted task matching the id in the list, else returns 0.

Member Data Documentation

boost::signal<void ()> makVrf::DtReactiveTaskOrganizer::signal_organized

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

makVrv::DtDe& makVrf::DtReactiveTaskOrganizer::myDe

protected

std::vector<makVrv::DtUniqueID> makVrf::DtReactiveTaskOrganizer::myEntries

protected

int makVrf::DtReactiveTaskOrganizer::myMaximumPriority

protected

std::set<std::string> makVrf::DtReactiveTaskOrganizer::myCommonScripts

protected

std::set<std::string> makVrf::DtReactiveTaskOrganizer::myEnabledScripts

protected

std::set<std::string> makVrf::DtReactiveTaskOrganizer::myDisabledScripts

protected

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation