The DtVisualMetaDataManager will use Vantage classes to read meta data files based on the given entity type, and, if the data exists, return a map of linkages and values that can be applied to those linkages to change aspects of the visual model associated with the entity type. More...

Inheritance diagram for makVrf::DtVrfVisualMetaDataManager:

[legend]

Public Member Functions
	DtVrfVisualMetaDataManager (makVrv::DtDe &)

	DtVrfVisualMetaDataManager (const DtVrfVisualMetaDataManager &)

virtual	~DtVrfVisualMetaDataManager ()
	Destructor. More...

virtual Markings	visualMetaDataFor (const DtEntityType &)

virtual std::vector < DtVrfModelManager::ModelInformation >	modelDefinitionsFor (const DtEntityType &objectType) const
	Returns the model definition for the given entity type. More...

virtual DtFilename	metaDataFileFor (const DtEntityType &) const
	Returns the meta data file that is used for the given entity type. More...

virtual std::map< std::string, std::string >	markingsFromVisualMetaData (const DtEntityType &, bool skipVariants=false, const std::map< std::string, std::string > &variantSelections=std::map< std::string, std::string >())
	Given the variable data rules, return a map that contains the annoation and the value for that annotation to be set. More...

virtual std::map< std::string, std::string >	markingsFromVisualMetaData (const std::vector< DtEntityType > &, bool skipVariants=false, const std::map< std::string, std::string > &variantSelections=std::map< std::string, std::string >())

virtual Markings	visualMetaDataFor (const std::vector< DtEntityType > &types, bool unionOf=true)
	Returns the visual meta data for the given entity type. More...

virtual Markings	visualMetaDataFor (const DtEntityType &types, bool unionOf)

virtual std::map< std::string, std::string >	subvariantToVariantMap (const std::vector< DtEntityType > &) const
	Returns a map of all subvariants to variants in the given entity type list. More...

virtual std::map< std::string, std::string >	subvariantToVariantMap (const DtEntityType &) const

virtual bool	isCountryLinkage (const std::string &) const
	Returns true if the curreent linkage can be considered a country linkage. More...

virtual void	setSelectedCountry (const std::string &)
	Special case for variant selection. Will set the country that should be used if there is no country by force. More...

virtual std::string	selectedCountry (int force, std::string &forceCountry) const
	Force country will be filled in for the country selected by the force. More...

virtual void	setSelectionByLinkage (const std::string &linkage, const std::string &marking)
	Sets a selection by the linkage name. More...

virtual std::string	selectionByLinkage (const std::string &linkage) const

virtual std::map< std::string, std::string >	markingsFor (const std::vector< makVrv::DtSimEntry * > &data) const
	Goes over all the objects in the entries, and, if aggregates, their subordinates, to figure out all the markings that are set. More...

virtual std::map< std::string, std::string >	markingsFor (makVrv::DtUniqueID id) const

virtual std::map< std::string, std::string >	markingsFor (const std::vector< makVrv::DtUniqueID > &) const

Public Member Functions inherited from DtVisualMetaDataManager
	DtVisualMetaDataManager ()
	CTOR. More...

	DtVisualMetaDataManager (const DtVisualMetaDataManager &)
	Copy Constructor. More...

virtual	~DtVisualMetaDataManager ()
	Destructor. More...

virtual Markings	visualMetaDataFor (const DtFilename &metaDataFile, const DtRwVisualMetaData &vmd=DtRwVisualMetaData(""))

virtual void	clear ()
	Clears out markings. More...

virtual std::map< std::string, std::string >	markingsFromVisualMetaData (const DtFilename &metaDataFile, const DtRwVisualMetaData &, bool skipVariants=false, const std::map< std::string, std::string > &variantSelections=std::map< std::string, std::string >())
	Given the variable data rules, return a map that contains the linkage and the value for that linkage to be set. More...

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtVrfVisualMetaDataManager &	instance (makVrv::DtDe &de)
	Returns instance of the DtActiveSonarModeRequestor. More...

static void	registerInstance (makVrv::DtDe &de, DtVrfVisualMetaDataManager *object)
	Register a subclass version of this class. More...

static std::string	uncategorizedCode ()
	The internal code that will select "Uncategorized". More...

static std::string	allCode ()
	The internal code that will select "All". More...

Static Public Member Functions inherited from DtVisualMetaDataManager
static DtVisualMetaDataManager *	setInstance (DtVisualMetaDataManager *)
	Returns the current instance. More...

static DtVisualMetaDataManager *	instance ()
	If instance does not exist will create a new version of this class. More...

Protected Types
typedef std::map< std::string, std::string >	SelectionsByLinkage

Protected Types inherited from DtVisualMetaDataManager
typedef std::map< std::string, Markings >	StoredMarkings

Protected Member Functions
virtual bool	intersectMarkings (Markings &result, const Markings &source) const
	Returns false if intersection should stop. More...

virtual void	unionMarkings (Markings &result, const Markings &source) const

virtual std::vector< DtEntityType >	typesToCheck (const std::vector< DtEntityType > &) const

Protected Member Functions inherited from DtVisualMetaDataManager
virtual std::vector< OrderedInfo >	orderFromSelection (const MarkingMappings &, const DtRwNLengthStringVector &) const
	Given the list of potential items to select from, return an in order list of the items to select. More...

virtual std::string	randomlySelect (const std::vector< OrderedInfo > &, double topPercentToChoose, double topRandomPrecent) const
	Given the ordered list return an randomly selected item. More...

virtual std::string	weightedExponential (const std::vector< OrderedInfo > &) const
	Given the ordered list return an randomly selected item as an exponential floor(num_items * pow(rand(0 ... 1), 2));. More...

virtual void *	loadMetaFile (const DtFilename &) const
	Returns the document for the given filename. User must close the document handle returned to prevent leak. More...

virtual std::string	variantSelection (const std::string &linkage, const Markings &, const DtRwVisualMetaDataEntry &) const
	Assuming a variant, given the linkage, return the first item. More...

virtual std::string	subvariantSelection (const std::string &linkage, const Markings &, const DtRwVisualMetaData &, const std::map< std::string, std::string > &variantSelections) const
	Assuming a subvariant, given the linkage, return the first item that satisfies the parent variant. More...

Protected Attributes
makVrv::DtDe &	myDe

std::string	mySelectedCountry

SelectionsByLinkage	mySelectionsByLinkage

Protected Attributes inherited from DtVisualMetaDataManager
StoredMarkings	myStoredMarkings

Additional Inherited Members
Public Types inherited from DtVisualMetaDataManager
typedef std::map< std::string, Mapping >	MarkingMappings

typedef std::map< std::string, Marking >	Markings

Static Protected Attributes inherited from DtVisualMetaDataManager
static DtVisualMetaDataManager *	theInstance

Detailed Description

The DtVisualMetaDataManager will use Vantage classes to read meta data files based on the given entity type, and, if the data exists, return a map of linkages and values that can be applied to those linkages to change aspects of the visual model associated with the entity type.

Member Typedef Documentation

typedef std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::SelectionsByLinkage

protected

Constructor & Destructor Documentation

makVrf::DtVrfVisualMetaDataManager::DtVrfVisualMetaDataManager ( makVrv::DtDe & )

makVrf::DtVrfVisualMetaDataManager::DtVrfVisualMetaDataManager ( const DtVrfVisualMetaDataManager & )

virtual makVrf::DtVrfVisualMetaDataManager::~DtVrfVisualMetaDataManager ( )

virtual

Destructor.

Member Function Documentation

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

static

Returns instance of the DtActiveSonarModeRequestor.

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

static

Register a subclass version of this class.

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

virtual Markings makVrf::DtVrfVisualMetaDataManager::visualMetaDataFor ( const DtEntityType & )

virtual

Reimplemented in DtSimulationVisualMetaDataManager.

virtual std::vector<DtVrfModelManager::ModelInformation> makVrf::DtVrfVisualMetaDataManager::modelDefinitionsFor ( const DtEntityType & objectType ) const

virtual

Returns the model definition for the given entity type.

This will only return a value if the objectType represents an object that is in the entity element definition map

virtual DtFilename makVrf::DtVrfVisualMetaDataManager::metaDataFileFor ( const DtEntityType & ) const

virtual

Returns the meta data file that is used for the given entity type.

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::markingsFromVisualMetaData	(	const DtEntityType &	,
		bool	skipVariants = `false`,
		const std::map< std::string, std::string > &	variantSelections = `std::map< std::string, std::string >()`
	)

virtual

Given the variable data rules, return a map that contains the annoation and the value for that annotation to be set.

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::markingsFromVisualMetaData	(	const std::vector< DtEntityType > &	,
		bool	skipVariants = `false`,
		const std::map< std::string, std::string > &	variantSelections = `std::map< std::string, std::string >()`
	)

virtual

virtual Markings makVrf::DtVrfVisualMetaDataManager::visualMetaDataFor	(	const std::vector< DtEntityType > &	types,
		bool	unionOf = `true`
	)

virtual

Returns the visual meta data for the given entity type.

If it is an entity to be created will inspect the entity and see if it also has subordinates to be created and gather up those markings. The gather rule will either give intersection or union

virtual Markings makVrf::DtVrfVisualMetaDataManager::visualMetaDataFor	(	const DtEntityType &	types,
		bool	unionOf
	)

virtual

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::subvariantToVariantMap ( const std::vector< DtEntityType > & ) const

virtual

Returns a map of all subvariants to variants in the given entity type list.

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::subvariantToVariantMap ( const DtEntityType & ) const

virtual

virtual bool makVrf::DtVrfVisualMetaDataManager::isCountryLinkage ( const std::string & ) const

virtual

Returns true if the curreent linkage can be considered a country linkage.

virtual void makVrf::DtVrfVisualMetaDataManager::setSelectedCountry ( const std::string & )

virtual

Special case for variant selection. Will set the country that should be used if there is no country by force.

virtual std::string makVrf::DtVrfVisualMetaDataManager::selectedCountry	(	int	force,
		std::string &	forceCountry
	)		const

virtual

Force country will be filled in for the country selected by the force.

This might be different than the last selected country

virtual void makVrf::DtVrfVisualMetaDataManager::setSelectionByLinkage	(	const std::string &	linkage,
		const std::string &	marking
	)

virtual

Sets a selection by the linkage name.

virtual std::string makVrf::DtVrfVisualMetaDataManager::selectionByLinkage ( const std::string & linkage ) const

virtual

static std::string makVrf::DtVrfVisualMetaDataManager::uncategorizedCode ( )

static

The internal code that will select "Uncategorized".

static std::string makVrf::DtVrfVisualMetaDataManager::allCode ( )

static

The internal code that will select "All".

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::markingsFor ( const std::vector< makVrv::DtSimEntry * > & data ) const

virtual

Goes over all the objects in the entries, and, if aggregates, their subordinates, to figure out all the markings that are set.

Note that if there are mixed markings then that marking will be whatever the first subordinate or entity checked is

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::markingsFor ( makVrv::DtUniqueID id ) const

virtual

virtual std::map<std::string, std::string> makVrf::DtVrfVisualMetaDataManager::markingsFor ( const std::vector< makVrv::DtUniqueID > & ) const

virtual

virtual bool makVrf::DtVrfVisualMetaDataManager::intersectMarkings	(	Markings &	result,
		const Markings &	source
	)		const

protectedvirtual

Returns false if intersection should stop.

virtual void makVrf::DtVrfVisualMetaDataManager::unionMarkings	(	Markings &	result,
		const Markings &	source
	)		const

protectedvirtual

virtual std::vector<DtEntityType> makVrf::DtVrfVisualMetaDataManager::typesToCheck ( const std::vector< DtEntityType > & ) const

protectedvirtual

Member Data Documentation

makVrv::DtDe& makVrf::DtVrfVisualMetaDataManager::myDe

protected

std::string makVrf::DtVrfVisualMetaDataManager::mySelectedCountry

protected

SelectionsByLinkage makVrf::DtVrfVisualMetaDataManager::mySelectionsByLinkage

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfGuiCore/vrfVisualMetaDataManager.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation