VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtReactiveTaskOrganizer Class Reference

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.

Public Member Functions

 DtReactiveTaskOrganizer (makVrv::DtDe &)
 
virtual ~DtReactiveTaskOrganizer ()
 
virtual void organize (const std::vector< makVrv::DtSimEntry * > &)
 
virtual bool addEnabledStatesTheSame (const DtSimTaskMessageType &, bool &enabled) const
 
virtual bool allPrioritiesAreTheSame (const DtSimTaskMessageType &, int &priority) const
 
virtual const std::set
< DtSimTaskMessageType > & 
disabledScripts () const
 
virtual const std::set
< DtSimTaskMessageType > & 
commonScripts () const
 
virtual const std::set
< DtSimTaskMessageType > & 
enabledScripts () const
 
virtual int maxPriority () const
 
virtual int maxNonMixedPriority () const
 
virtual std::vector
< DtScriptedTaskVariable
variablesFor (const DtSimTaskMessageType &) const
 

Public Attributes

boost::signals2::signal< void()> signal_organized
 

Protected Member Functions

virtual void slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &entry)
 
virtual void allTasksReceived ()
 
virtual const DtScriptedTaskTaskscriptedTaskFor (const DtSimTaskMessageType &id, const DtVrfCurrentTaskManager::EntityTaskInformation &taskInformation) const
 

Protected Attributes

makVrv::DtDemyDe
 
std::vector< makVrv::DtUniqueIDmyEntries
 
int myMaximumPriority
 
std::set< DtSimTaskMessageTypemyCommonScripts
 
std::set< DtSimTaskMessageTypemyEnabledScripts
 
std::set< DtSimTaskMessageTypemyDisabledScripts
 

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 DtSimTaskMessageType ,
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 DtSimTaskMessageType ,
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<DtSimTaskMessageType>& makVrf::DtReactiveTaskOrganizer::disabledScripts ( ) const
virtual

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

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

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

virtual const std::set<DtSimTaskMessageType>& 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 DtSimTaskMessageType ) 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 DtSimTaskMessageType id,
const DtVrfCurrentTaskManager::EntityTaskInformation taskInformation 
) const
protectedvirtual

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

Member Data Documentation

boost::signals2::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<DtSimTaskMessageType> makVrf::DtReactiveTaskOrganizer::myCommonScripts
protected
std::set<DtSimTaskMessageType> makVrf::DtReactiveTaskOrganizer::myEnabledScripts
protected
std::set<DtSimTaskMessageType> makVrf::DtReactiveTaskOrganizer::myDisabledScripts
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)