The DtVrfGuiOrbatManager is the interface to determine if items are in the orbat hierarchy or not. More...

Inheritance diagram for makVrf::DtVrfGuiOrbatManager:

Classes
struct	OrbatWithRwOrbatData
struct	OrbatWithStateView

Public Types
typedef std::map< DtUUID, OrbatWithStateView >	OrbatTreeWithStateView
typedef std::map< DtUUID, OrbatWithRwOrbatData >	OrbatTreeWithRwOrbatData

Public Member Functions
virtual	~DtVrfGuiOrbatManager ()
	Destructor.
virtual void	removeObjectFromOrbat (makVrv::DtUniqueID)
	Removes the given objects from the orbat.
virtual void	removeObjectsFromOrbat (const std::vector< makVrv::DtUniqueID > &)
	Calls removeObjectsFromOrbat(const std::vector<DtUUID>&);.
virtual void	removeObjectFromOrbat (const DtUUID &)
	Calls removeObjectsFromOrbat(const std::vector<DtUUID>&);.
virtual void	removeObjectsFromOrbat (const std::vector< DtUUID > &)
virtual DtUUID	orbatUUID (makVrv::DtUniqueID) const
	Returns UUID of simulation object to be created from orbat node.
virtual void	addObjectToOrbat (const DtString &name, const DtUUID &uuid, const DtEntityType &entityType, int force, const DtUUID &parent=DtUUID::nullUUID(), bool createSubordinates=true)
	Send a message to this object as something that can be created in the orbat.
virtual void	addObjectsToOrbat (const std::vector< DtRwOrbatData > &, bool createSubordinates=true)
	Adds all the objects to the orbat.
virtual void	requestOrbatList ()
	Requests the entire list of orbat information.
virtual bool	inOrbatViewOnly (makVrv::DtUniqueID) const
	Returns true if the item is in the orbat view only (not created)
virtual bool	inOrbatViewOnly (const DtUUID &) const
virtual bool	inOrbatView (makVrv::DtUniqueID) const
	Returns true if the item is in the orbat view (whether or not it is created)
virtual bool	inOrbatView (const DtUUID &) const
virtual bool	isOrbatNode (makVrv::DtUniqueID) const
	Returns true if this id is an orbat node.
virtual const makVrv::DtStateView < DtOrbatState > *	orbatData (makVrv::DtUniqueID) const
	Returns the state view of the orbat node represented by the id given.
virtual const makVrv::DtStateView < DtOrbatState > *	orbatData (const DtUUID &) const
virtual const makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	orbatStateData (makVrv::DtUniqueID) const
virtual const makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	orbatStateData (const DtUUID &) const
virtual void	makePartOfOrbat (makVrv::DtUniqueID)
	If the item(s) specified are not already part of the orbat, send a message off to make the items part of the orbat Calls makePartOfOrbat(const std::vector<makVrv::DtUniqueID>&)
virtual void	makePartOfOrbat (const std::vector< makVrv::DtUniqueID > &)
	Calls makePartOfOrbat(const std::vector<DtUUID>&)
virtual void	makePartOfOrbat (const DtUUID &)
	Calls makePartOfOrbat(const std::vector<DtUUID>&)
virtual void	makePartOfOrbat (const std::vector< DtUUID > &)
	Sends the message off to make the items part of the orbat.
virtual void	makeAllSimulationObjectsPartOfOrbat ()
	Sends a message to make all the items that are not part of the ORBAT part of the ORBAT.
virtual void	removeAllSimulationObjectsFromOrbat ()
	Sends a message to remove all items in the ORBAT from the ORBAT.
virtual void	modifyOrbatEntry (makVrv::DtUniqueID, const DtRwOrbatData &)
	Modifies the orbat entry with either a new potential orbat data. Only set the values you wish to change.
virtual void	modifyOrbatEntry (const DtUUID &, const DtRwOrbatData &)
virtual void	setOrbatOrder (makVrv::DtUniqueID, int)
	Sets the orbat order of the entry.
virtual void	setOrbatOrder (const DtUUID &, int)
virtual void	reparentOrbatEntry (makVrv::DtUniqueID, makVrv::DtUniqueID parentID, int orbatOrder=-1)
	Reparents the node to an orbat node.
virtual void	reparentOrbatEntries (const std::vector< makVrv::DtUniqueID > &, makVrv::DtUniqueID parentID, int orbatOrder=-1)
virtual void	reparentOrbatEntry (const DtUUID &, makVrv::DtUniqueID parentID, int orbatOrder=-1)
virtual void	reparentOrbatEntries (const std::vector< DtUUID > &, makVrv::DtUniqueID parentID, int orbatOrder=-1)
virtual void	reparentToForce (makVrv::DtUniqueID, int force, int orbatOrder=-1)
	Reparents the node to a force level parent.
virtual void	reparentToForce (const std::vector< makVrv::DtUniqueID > &, int force, int orbatOrder=-1)
virtual void	reparentToForce (const DtUUID &, int force, int orbatOrder=-1)
virtual void	reparentToForce (const std::vector< DtUUID > &, int force, int orbatOrder=-1)
virtual DtUUID	parentUUIDOfOrbatNode (makVrv::DtUniqueID id) const
	If this orbat has an orbat node parent then return that.
virtual makVrv::DtUniqueID	orbatId (makVrv::DtUniqueID) const
	Given the id return the orbat node id if this item is in the orbat. May return the id passed in.
virtual makVrv::DtUniqueID	orbatId (const DtUUID &) const
virtual bool	isCreated (makVrv::DtUniqueID) const
	Given the id (orbat) see if there is an item that is created from this orbat node.
virtual makVrv::DtUniqueID	createdId (makVrv::DtUniqueID) const
	Given the orbat id, return the entity that is created that is represented by this orbat id.
virtual void	clearOrbatList ()
	Sends signal via the shared network signaler to clear out orbat nodes.
virtual int	orbatOrder (makVrv::DtUniqueID) const
	If this item is in the orbat view returns the orbat order of the item, else returns -1.
virtual int	orbatOrder (const DtUUID &) const
virtual void	exportOrbat (const DtFilename &, const std::set< std::string > &smsFilenames=std::set< std::string >())
	Exports the orbat hierarchy as an MSDL file (with no locations for objects) using the orbat msdl importer/exporter.
virtual OrbatTreeWithStateView	orbat () const
	Returns the tree (in orbat order) of orbat nodes in this simulation.
virtual bool	importOrbat (const DtFilename &, std::vector< DtRwOrbatData > &)
	Starts the process of importing the ORBAT from the given MSDL file.
virtual DtVrfGuiOrbatManager::OrbatTreeWithRwOrbatData	orbatFromFile (const DtFilename &, DtScenario &scenario)
	Requests to read the given orbat file.
virtual void	createOrbatObject (const DtUUID &, const DtVector &location)
	If not already created, creates the orbat object at the given geocentric location.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfGuiOrbatManager &	instance (makVrv::DtDe &de)
	Returns instance of the DtActiveSonarModeRequestor.
static void	registerInstance (makVrv::DtDe &de, DtVrfGuiOrbatManager *object)
	Register a subclass version of this class.

Public Attributes
boost::signal< void(makVrv::DtUniqueID, bool)>	signal_orbatStateChanged
	Sent when the orbat state has changed (in or out of orbat)
boost::signal< void(makVrv::DtUniqueID)>	signal_orbatObjectAdded
	Signal sent when an orbat object is added.
boost::signal< void(makVrv::DtUniqueID)>	signal_orbatObjectRemoved
	Signal sent when an orbat object is removed.

Protected Types
typedef std::map< DtUUID, makVrv::DtUniqueID >	OrbatStateViews

Protected Member Functions
	DtVrfGuiOrbatManager (makVrv::DtDe &)
	Class constructor is protected, use instance function instead.
virtual void	initialize ()
virtual void	hierarchyItemsModified (const makVrv::DtElementData::EntryAttributesList &l)
virtual void	slot_stateAdded (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void	slot_stateRemoved (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

Protected Attributes
makVrv::DtDe &	myDe
makVrv::DtSignalConnectionManager	myConnections
OrbatStateViews	myOrbatStateViews
std::set< makVrv::DtUniqueID >	myMarkingTextResolvers

Detailed Description

The DtVrfGuiOrbatManager is the interface to determine if items are in the orbat hierarchy or not.

Member Typedef Documentation

typedef std::map<DtUUID, OrbatWithStateView> makVrf::DtVrfGuiOrbatManager::OrbatTreeWithStateView

typedef std::map<DtUUID, OrbatWithRwOrbatData> makVrf::DtVrfGuiOrbatManager::OrbatTreeWithRwOrbatData

typedef std::map<DtUUID, makVrv::DtUniqueID> makVrf::DtVrfGuiOrbatManager::OrbatStateViews

protected

Constructor & Destructor Documentation

virtual makVrf::DtVrfGuiOrbatManager::~DtVrfGuiOrbatManager ( )

virtual

Destructor.

makVrf::DtVrfGuiOrbatManager::DtVrfGuiOrbatManager ( makVrv::DtDe & )

protected

Class constructor is protected, use instance function instead.

Member Function Documentation

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

static

Returns instance of the DtActiveSonarModeRequestor.

static void makVrf::DtVrfGuiOrbatManager::registerInstance	(	makVrv::DtDe &	de,
		DtVrfGuiOrbatManager *	object
	)

static

Register a subclass version of this class.

the instance() function will return the newly registered version once this has been called.

virtual void makVrf::DtVrfGuiOrbatManager::removeObjectFromOrbat ( makVrv::DtUniqueID )

virtual

Removes the given objects from the orbat.

If a parent node, removes all children from the orbat Calls removeObjectsFromOrbat(const std::vector<makVrv::DtUniqueID>&)

virtual void makVrf::DtVrfGuiOrbatManager::removeObjectsFromOrbat ( const std::vector< makVrv::DtUniqueID > & )

virtual

Calls removeObjectsFromOrbat(const std::vector<DtUUID>&);.

virtual void makVrf::DtVrfGuiOrbatManager::removeObjectFromOrbat ( const DtUUID & )

virtual

Calls removeObjectsFromOrbat(const std::vector<DtUUID>&);.

virtual void makVrf::DtVrfGuiOrbatManager::removeObjectsFromOrbat ( const std::vector< DtUUID > & )

virtual

virtual DtUUID makVrf::DtVrfGuiOrbatManager::orbatUUID ( makVrv::DtUniqueID ) const

virtual

Returns UUID of simulation object to be created from orbat node.

virtual void makVrf::DtVrfGuiOrbatManager::addObjectToOrbat	(	const DtString &	name,
		const DtUUID &	uuid,
		const DtEntityType &	entityType,
		int	force,
		const DtUUID &	parent = `DtUUID::nullUUID()`,
		bool	createSubordinates = `true`
	)

virtual

Send a message to this object as something that can be created in the orbat.

virtual void makVrf::DtVrfGuiOrbatManager::addObjectsToOrbat	(	const std::vector< DtRwOrbatData > &	,
		bool	createSubordinates = `true`
	)

virtual

Adds all the objects to the orbat.

virtual void makVrf::DtVrfGuiOrbatManager::requestOrbatList ( )

virtual

Requests the entire list of orbat information.

virtual bool makVrf::DtVrfGuiOrbatManager::inOrbatViewOnly ( makVrv::DtUniqueID ) const

virtual

Returns true if the item is in the orbat view only (not created)

virtual bool makVrf::DtVrfGuiOrbatManager::inOrbatViewOnly ( const DtUUID & ) const

virtual

virtual bool makVrf::DtVrfGuiOrbatManager::inOrbatView ( makVrv::DtUniqueID ) const

virtual

Returns true if the item is in the orbat view (whether or not it is created)

virtual bool makVrf::DtVrfGuiOrbatManager::inOrbatView ( const DtUUID & ) const

virtual

virtual bool makVrf::DtVrfGuiOrbatManager::isOrbatNode ( makVrv::DtUniqueID ) const

virtual

Returns true if this id is an orbat node.

virtual const makVrv::DtStateView<DtOrbatState>* makVrf::DtVrfGuiOrbatManager::orbatData ( makVrv::DtUniqueID ) const

virtual

Returns the state view of the orbat node represented by the id given.

If the id is a published id will return the orbat representation of that node (if it exists)

virtual const makVrv::DtStateView<DtOrbatState>* makVrf::DtVrfGuiOrbatManager::orbatData ( const DtUUID & ) const

virtual

virtual const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfGuiOrbatManager::orbatStateData ( makVrv::DtUniqueID ) const

virtual

virtual const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfGuiOrbatManager::orbatStateData ( const DtUUID & ) const

virtual

virtual void makVrf::DtVrfGuiOrbatManager::makePartOfOrbat ( makVrv::DtUniqueID )

virtual

If the item(s) specified are not already part of the orbat, send a message off to make the items part of the orbat Calls makePartOfOrbat(const std::vector<makVrv::DtUniqueID>&)

virtual void makVrf::DtVrfGuiOrbatManager::makePartOfOrbat ( const std::vector< makVrv::DtUniqueID > & )

virtual

Calls makePartOfOrbat(const std::vector<DtUUID>&)

virtual void makVrf::DtVrfGuiOrbatManager::makePartOfOrbat ( const DtUUID & )

virtual

Calls makePartOfOrbat(const std::vector<DtUUID>&)

virtual void makVrf::DtVrfGuiOrbatManager::makePartOfOrbat ( const std::vector< DtUUID > & )

virtual

Sends the message off to make the items part of the orbat.

virtual void makVrf::DtVrfGuiOrbatManager::makeAllSimulationObjectsPartOfOrbat ( )

virtual

Sends a message to make all the items that are not part of the ORBAT part of the ORBAT.

virtual void makVrf::DtVrfGuiOrbatManager::removeAllSimulationObjectsFromOrbat ( )

virtual

Sends a message to remove all items in the ORBAT from the ORBAT.

virtual void makVrf::DtVrfGuiOrbatManager::modifyOrbatEntry	(	makVrv::DtUniqueID	,
		const DtRwOrbatData &
	)

virtual

Modifies the orbat entry with either a new potential orbat data. Only set the values you wish to change.

virtual void makVrf::DtVrfGuiOrbatManager::modifyOrbatEntry	(	const DtUUID &	,
		const DtRwOrbatData &
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::setOrbatOrder	(	makVrv::DtUniqueID	,
		int
	)

virtual

Sets the orbat order of the entry.

virtual void makVrf::DtVrfGuiOrbatManager::setOrbatOrder	(	const DtUUID &	,
		int
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentOrbatEntry	(	makVrv::DtUniqueID	,
		makVrv::DtUniqueID	parentID,
		int	orbatOrder = `-1`
	)

virtual

Reparents the node to an orbat node.

If the node is being parented to a node that is not in the orbat, then the nodes that are not in the orbat will be added to the orbat. If the node is not in the orbat and the parent is in the orbat, the node will be added to the orbat. If the node is created and the orbat nodes are not created they will be created. If orbatOrder is -1 will be added to the end of the orbat order of the parent. If the parent is the same as the current parent only the orbat order will be changed

virtual void makVrf::DtVrfGuiOrbatManager::reparentOrbatEntries	(	const std::vector< makVrv::DtUniqueID > &	,
		makVrv::DtUniqueID	parentID,
		int	orbatOrder = `-1`
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentOrbatEntry	(	const DtUUID &	,
		makVrv::DtUniqueID	parentID,
		int	orbatOrder = `-1`
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentOrbatEntries	(	const std::vector< DtUUID > &	,
		makVrv::DtUniqueID	parentID,
		int	orbatOrder = `-1`
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentToForce	(	makVrv::DtUniqueID	,
		int	force,
		int	orbatOrder = `-1`
	)

virtual

Reparents the node to a force level parent.

virtual void makVrf::DtVrfGuiOrbatManager::reparentToForce	(	const std::vector< makVrv::DtUniqueID > &	,
		int	force,
		int	orbatOrder = `-1`
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentToForce	(	const DtUUID &	,
		int	force,
		int	orbatOrder = `-1`
	)

virtual

virtual void makVrf::DtVrfGuiOrbatManager::reparentToForce	(	const std::vector< DtUUID > &	,
		int	force,
		int	orbatOrder = `-1`
	)

virtual

virtual DtUUID makVrf::DtVrfGuiOrbatManager::parentUUIDOfOrbatNode ( makVrv::DtUniqueID id ) const

virtual

If this orbat has an orbat node parent then return that.

virtual makVrv::DtUniqueID makVrf::DtVrfGuiOrbatManager::orbatId ( makVrv::DtUniqueID ) const

virtual

Given the id return the orbat node id if this item is in the orbat. May return the id passed in.

virtual makVrv::DtUniqueID makVrf::DtVrfGuiOrbatManager::orbatId ( const DtUUID & ) const

virtual

virtual bool makVrf::DtVrfGuiOrbatManager::isCreated ( makVrv::DtUniqueID ) const

virtual

Given the id (orbat) see if there is an item that is created from this orbat node.

virtual makVrv::DtUniqueID makVrf::DtVrfGuiOrbatManager::createdId ( makVrv::DtUniqueID ) const

virtual

Given the orbat id, return the entity that is created that is represented by this orbat id.

virtual void makVrf::DtVrfGuiOrbatManager::clearOrbatList ( )

virtual

Sends signal via the shared network signaler to clear out orbat nodes.

virtual int makVrf::DtVrfGuiOrbatManager::orbatOrder ( makVrv::DtUniqueID ) const

virtual

If this item is in the orbat view returns the orbat order of the item, else returns -1.

virtual int makVrf::DtVrfGuiOrbatManager::orbatOrder ( const DtUUID & ) const

virtual

virtual void makVrf::DtVrfGuiOrbatManager::exportOrbat	(	const DtFilename &	,
		const std::set< std::string > &	smsFilenames = `std::set< std::string >()`
	)

virtual

Exports the orbat hierarchy as an MSDL file (with no locations for objects) using the orbat msdl importer/exporter.

Optional sms filenames that were loaded when exporting this orbat

virtual OrbatTreeWithStateView makVrf::DtVrfGuiOrbatManager::orbat ( ) const

virtual

Returns the tree (in orbat order) of orbat nodes in this simulation.

Do not hold onto this pointer as the state views can be removed from the system without the return list being updated, causing stale pointers. The return will be in orbat order

virtual bool makVrf::DtVrfGuiOrbatManager::importOrbat	(	const DtFilename &	,
		std::vector< DtRwOrbatData > &
	)

virtual

Starts the process of importing the ORBAT from the given MSDL file.

This will only import objects that are not currently in the ORBAT (by UUID). Returns false if the file cannot be opened. Supplied vector will contain all data imported

virtual DtVrfGuiOrbatManager::OrbatTreeWithRwOrbatData makVrf::DtVrfGuiOrbatManager::orbatFromFile	(	const DtFilename &	,
		DtScenario &	scenario
	)

virtual

Requests to read the given orbat file.

Will signal_orbatFileRead when the read is complete. This is a request because some information is needed from the back-end to map MSDL types from the file

virtual void makVrf::DtVrfGuiOrbatManager::createOrbatObject	(	const DtUUID &	,
		const DtVector &	location
	)

virtual

If not already created, creates the orbat object at the given geocentric location.

virtual void makVrf::DtVrfGuiOrbatManager::initialize ( )

protectedvirtual

virtual void makVrf::DtVrfGuiOrbatManager::hierarchyItemsModified ( const makVrv::DtElementData::EntryAttributesList & l )

protectedvirtual

virtual void makVrf::DtVrfGuiOrbatManager::slot_stateAdded ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * )

protectedvirtual

virtual void makVrf::DtVrfGuiOrbatManager::slot_stateRemoved ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * )

protectedvirtual

Member Data Documentation

boost::signal<void (makVrv::DtUniqueID, bool)> makVrf::DtVrfGuiOrbatManager::signal_orbatStateChanged

Sent when the orbat state has changed (in or out of orbat)

boost::signal<void (makVrv::DtUniqueID)> makVrf::DtVrfGuiOrbatManager::signal_orbatObjectAdded

Signal sent when an orbat object is added.

boost::signal<void (makVrv::DtUniqueID)> makVrf::DtVrfGuiOrbatManager::signal_orbatObjectRemoved

Signal sent when an orbat object is removed.

makVrv::DtDe& makVrf::DtVrfGuiOrbatManager::myDe

protected

makVrv::DtSignalConnectionManager makVrf::DtVrfGuiOrbatManager::myConnections

protected

OrbatStateViews makVrf::DtVrfGuiOrbatManager::myOrbatStateViews

protected

std::set<makVrv::DtUniqueID> makVrf::DtVrfGuiOrbatManager::myMarkingTextResolvers

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCore/vrfGuiOrbatManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation