DtVrfCsvScenarioDescriptionImporterExporter Class Reference

This class is the interface for import from or export to CSV files. This class will not interact with the simulation engine directory. The subclass vrfCSVScenarioDescriptionImporterExporter will perform that action based on what this class reads in from the file.

This CSV file will contain the following information (in column format): NAME - The name of the object ENUMERATION - The DIS enumeration FORCE - The object's FORCE SUPERIOR OR OVERLAY - The name of the superior or overlay this object is on, or blank if none POINTS - Triplets of points in DDS (degrees) LAT/LON/ALT

This file will extend the import/export class by interfacing with the simulation engine to incorporate scenario information

Inheritance diagram for DtVrfCsvScenarioDescriptionImporterExporter:

Public Member Functions
	DtVrfCsvScenarioDescriptionImporterExporter (DtSimulationServices *)
	DtVrfCsvScenarioDescriptionImporterExporter (const DtVrfCsvScenarioDescriptionImporterExporter &)
virtual	~DtVrfCsvScenarioDescriptionImporterExporter ()
virtual DtScenarioDescriptionImporterExporter *	clone ()
virtual bool	importIntoSimulation (DtSimulationServices *)
virtual bool	importFromSimulation (DtSimulationServices *, const std::map< std::string, std::string > &exportData, const DtMsdlHierarchyPropertyMappings &)
Public Member Functions inherited from DtCsvScenarioDescriptionImporterExporter
	DtCsvScenarioDescriptionImporterExporter ()
virtual	~DtCsvScenarioDescriptionImporterExporter ()
virtual bool	loadScenarioDescription (const DtFilename &file, const std::map< std::string, std::string > &importData)
virtual bool	saveScenarioDescription (const DtFilename &file, const DtScenario &) const
virtual std::string	supportedExtensions ()
virtual bool	canImportFile (const DtFilename &)
virtual void	setAltInAGL (const bool agl)
virtual void	setOptionalName (const std::string &name)
virtual DtObjectParser *	parser ()
Public Member Functions inherited from DtScenarioDescriptionImporterExporter
	DtScenarioDescriptionImporterExporter ()
virtual	~DtScenarioDescriptionImporterExporter ()
const DtScenario &	scenario () const
const std::string &	error () const
virtual void	setDesiredForce (int force)

Protected Member Functions
virtual bool	exportOrganization (const std::map< std::string, std::string > &exportData, const DtMsdlHierarchyPropertyMappings &)
virtual void	determineAltitude (const DtVector &local, DtGeodeticCoord &geod, bool useAGL)
virtual bool	exportTacticalGraphics (const std::map< std::string, std::string > &exportData, const DtMsdlHierarchyPropertyMappings &)
virtual bool	complete () const
virtual bool	importOrganization ()
virtual bool	importTacticalGraphics ()
virtual bool	prepareOrganizationCreationOrder (ObjectInformation *element)
virtual void	processCreateObjects ()
virtual void	createEntity (ObjectInformation *)
virtual void	createTacticalGraphic (ObjectInformation *)
virtual DtString	deconflictName (const DtString &, int kind)

Static Protected Member Functions
static void	createObjectsCallback (void *)

Protected Attributes
std::vector< ObjectInformation * >	myOrganizedHierarchy
std::vector< ObjectInformation * >	myOrganizationCreationOrder
DtSimulationServices *	mySimulationServices
Protected Attributes inherited from DtCsvScenarioDescriptionImporterExporter
bool	myIsAgl
std::string	myOptionalName
Protected Attributes inherited from DtScenarioDescriptionImporterExporter
DtScenario	myScenario
std::string	myError
DtObjectParser *	myParser
DtForceType	myDesiredForce

Constructor & Destructor Documentation

DtVrfCsvScenarioDescriptionImporterExporter::DtVrfCsvScenarioDescriptionImporterExporter

(

DtSimulationServices *

)

DtVrfCSVScenarioDescriptionImporterExporter.

DtVrfCsvScenarioDescriptionImporterExporter::DtVrfCsvScenarioDescriptionImporterExporter

(

const DtVrfCsvScenarioDescriptionImporterExporter &

)

virtual DtVrfCsvScenarioDescriptionImporterExporter::~DtVrfCsvScenarioDescriptionImporterExporter ( )

virtual

DTOR.

Member Function Documentation

virtual DtScenarioDescriptionImporterExporter* DtVrfCsvScenarioDescriptionImporterExporter::clone ( )

virtual

Clone to create a new copy of the object. Will be used as a "clean" version for import.

Reimplemented from DtCsvScenarioDescriptionImporterExporter.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::importIntoSimulation ( DtSimulationServices *  )

virtual

Imports into the simulation.

Reimplemented from DtCsvScenarioDescriptionImporterExporter.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::importFromSimulation ( DtSimulationServices *  , const std::map< std::string, std::string > &  exportData, const DtMsdlHierarchyPropertyMappings &    )

virtual

Imports from the simulation into internal structures.

Reimplemented from DtCsvScenarioDescriptionImporterExporter.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::exportOrganization ( const std::map< std::string, std::string > &  exportData, const DtMsdlHierarchyPropertyMappings &    )

protectedvirtual

Exports the entities and aggregates into internal structures.

virtual void DtVrfCsvScenarioDescriptionImporterExporter::determineAltitude ( const DtVector &  local, DtGeodeticCoord &  geod, bool  useAGL  )

protectedvirtual

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::exportTacticalGraphics ( const std::map< std::string, std::string > &  exportData, const DtMsdlHierarchyPropertyMappings &    )

protectedvirtual

Exports the tactical graphics into internal structures.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::complete ( ) const

protectedvirtual

Returns true if myOrganizationCreationOrder is 0 length.

Reimplemented from DtScenarioDescriptionImporterExporter.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::importOrganization ( )

protectedvirtual

Schedule aggregates/entities for creation.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::importTacticalGraphics ( )

protectedvirtual

Schedule tactical graphics for creation.

virtual bool DtVrfCsvScenarioDescriptionImporterExporter::prepareOrganizationCreationOrder ( ObjectInformation *  element )

protectedvirtual

Recursively add elements in order to be created – entities then containing superiors. Once all elements from a hierarchy have been scheduled to be create, set marker to wait until next tick to create other elements.

static void DtVrfCsvScenarioDescriptionImporterExporter::createObjectsCallback ( void *  )

staticprotected

Creates objects.

virtual void DtVrfCsvScenarioDescriptionImporterExporter::processCreateObjects ( )

protectedvirtual

virtual void DtVrfCsvScenarioDescriptionImporterExporter::createEntity ( ObjectInformation *  )

protectedvirtual

Creates an entity or an aggregate. If an aggregate will also aggregate entities into the hierarchy.

virtual void DtVrfCsvScenarioDescriptionImporterExporter::createTacticalGraphic ( ObjectInformation *  )

protectedvirtual

Creates a tactical graphic object.

virtual DtString DtVrfCsvScenarioDescriptionImporterExporter::deconflictName ( const DtString &  , int  kind  )

protectedvirtual

Deconflicts duplicate names if they appear in the object manager. Will simply prepend a <n>_ to the name.

Member Data Documentation

std::vector<ObjectInformation*> DtVrfCsvScenarioDescriptionImporterExporter::myOrganizedHierarchy

protected

Hierarchy with top level nodes and tactical graphics only. This is what will be used to create the objects in the simulation.

std::vector<ObjectInformation*> DtVrfCsvScenarioDescriptionImporterExporter::myOrganizationCreationOrder

protected

Order in which to create organization items or tactical graphics. Empty elements will signal to stop the creation for this tick and continue next tick.

DtSimulationServices* DtVrfCsvScenarioDescriptionImporterExporter::mySimulationServices

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/vrfCsvScenarioDescriptionImporterExporter.h