DtScriptedMovementFileConfiguration Class Reference

The DtScriptedMovementObject will contain information about an object that can be used for scripted movement. More...

Classes
struct	Column

Public Types
enum	TimeConversion { Milliseconds = 0, Seconds, Minutes, Hours }
enum	DistanceConversion {   Feet = 0, Meters, Miles, Kilometers,   NauticalMiles }
typedef std::vector< Column >	Columns

Public Member Functions
	DtScriptedMovementFileConfiguration ()
	CTOR.
virtual	~DtScriptedMovementFileConfiguration ()
	DTOR.
	DtScriptedMovementFileConfiguration (const DtScriptedMovementFileConfiguration &)
	Copy constructor.
DtScriptedMovementFileConfiguration &	operator= (const DtScriptedMovementFileConfiguration &)
	Assignment operator.
virtual void	addColumn (const std::string &type, const std::string &units, int columnInFile=-1)
	adds a new column into the configuration.
virtual void	removeColumn (int)
	Removes a column at the given index.
virtual const Columns &	columns () const
	Columsn accessor.
virtual void	setColumns (const Columns &)
virtual void	setRowStart (int)
	Sets the first row to start reading from, assuming possible header rows.
virtual int	rowStart () const
virtual int	timeColumn () const
	Column that represents time. -1 if no column exists.
virtual int	altitudeColumn () const
	Returns the altitude column. -1 if no column exits.
virtual DistanceConversion	altitudeUnits () const
virtual int	rangeColumn () const
	Returns the range column. -1 if no column exits.
virtual DistanceConversion	rangeUnits () const
virtual int	lateralDistanceColumn () const
	Returns the lateral distance column. -1 if no column exits.
virtual DistanceConversion	lateralDistanceUnits () const
virtual double	convertTimeToSeconds (double time) const
	Converts supplied time value to seconds (given a time column, else simply returns value)
virtual void	updateCache ()
	Updates the cache values.
virtual TimeConversion	mapTimeToInternalValue (const std::string &) const
virtual DistanceConversion	mapDistanceToInternalValue (const std::string &) const
virtual double	convertDistanceToMeters (double d, DistanceConversion conv) const
	Converts distance units to meters given native format.
virtual DtString	toString () const
	Convert to a simple comma delimited string.
virtual void	fromString (const DtString &)
	Convert back from comma delimeted string.
virtual bool	setColumn (int col, const std::string &type, const std::string &unit, int columnInFile=-1)
	Sets the information for the particular column.
virtual void	column (int col, int &columnInFile, std::string &type, std::string &unit) const
	Retrieves information about the column.

Static Public Member Functions
static DtScriptedMovementFileConfiguration	defaultConfiguration ()
	Returns a default configuration of 4 columns where the first column is time in seconds, second lateral distance in km, third is altitude in km and fourth is range in km.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
int	myRowStart
Columns	myColumns
int	myCachedColumns [4][2]
	Cache of column values.

Friends
class	boost::serialization::access
	Serialization/Deserialization //.

Detailed Description

The DtScriptedMovementObject will contain information about an object that can be used for scripted movement.

This file will contain classes to define the configuration for the csv file being loaded as well as the phases of deployment and movement of scripted objects

Information is saved in XML format Defines the configuration of the csv files read as part of the phases of the scripted movement object

Member Typedef Documentation

typedef std::vector<Column> DtScriptedMovementFileConfiguration::Columns

Member Enumeration Documentation

enum DtScriptedMovementFileConfiguration::TimeConversion

Enumerator:

Milliseconds
Seconds
Minutes
Hours

enum DtScriptedMovementFileConfiguration::DistanceConversion

Enumerator:

Feet
Meters
Miles
Kilometers
NauticalMiles

Constructor & Destructor Documentation

DtScriptedMovementFileConfiguration::DtScriptedMovementFileConfiguration

(

)

CTOR.

virtual DtScriptedMovementFileConfiguration::~DtScriptedMovementFileConfiguration ( )

virtual

DTOR.

DtScriptedMovementFileConfiguration::DtScriptedMovementFileConfiguration

(

const DtScriptedMovementFileConfiguration &

)

Copy constructor.

Member Function Documentation

DtScriptedMovementFileConfiguration& DtScriptedMovementFileConfiguration::operator=

(

const DtScriptedMovementFileConfiguration &

)

Assignment operator.

virtual void DtScriptedMovementFileConfiguration::addColumn ( const std::string &  type, const std::string &  units, int  columnInFile = -1  )

virtual

adds a new column into the configuration.

A column is defined as a type and a unit of type: Data types can be of Time - expected simulation time lateral-distance - Distance along the "x" dimension the object will be away from the target at time Time altitude - Altitude along the "z" dimension the object will be away from the target at time Time range - Altitude along the "y" dimension the object will be away from the target at time Time

units can be

For time: seconds minutes miliseconds hours

For distance items

m - Meters km - Kilometers ft - Feet mi - miles nm - nautical miles If column in file is -1 will simply set column to be the next column available

virtual void DtScriptedMovementFileConfiguration::removeColumn ( int  )

virtual

Removes a column at the given index.

virtual const Columns& DtScriptedMovementFileConfiguration::columns ( ) const

virtual

Columsn accessor.

virtual void DtScriptedMovementFileConfiguration::setColumns ( const Columns &  )

virtual

virtual void DtScriptedMovementFileConfiguration::setRowStart ( int  )

virtual

Sets the first row to start reading from, assuming possible header rows.

virtual int DtScriptedMovementFileConfiguration::rowStart ( ) const

virtual

virtual int DtScriptedMovementFileConfiguration::timeColumn ( ) const

virtual

Column that represents time. -1 if no column exists.

virtual int DtScriptedMovementFileConfiguration::altitudeColumn ( ) const

virtual

Returns the altitude column. -1 if no column exits.

virtual DistanceConversion DtScriptedMovementFileConfiguration::altitudeUnits ( ) const

virtual

virtual int DtScriptedMovementFileConfiguration::rangeColumn ( ) const

virtual

Returns the range column. -1 if no column exits.

virtual DistanceConversion DtScriptedMovementFileConfiguration::rangeUnits ( ) const

virtual

virtual int DtScriptedMovementFileConfiguration::lateralDistanceColumn ( ) const

virtual

Returns the lateral distance column. -1 if no column exits.

virtual DistanceConversion DtScriptedMovementFileConfiguration::lateralDistanceUnits ( ) const

virtual

virtual double DtScriptedMovementFileConfiguration::convertTimeToSeconds ( double  time ) const

virtual

Converts supplied time value to seconds (given a time column, else simply returns value)

virtual void DtScriptedMovementFileConfiguration::updateCache ( )

virtual

Updates the cache values.

virtual TimeConversion DtScriptedMovementFileConfiguration::mapTimeToInternalValue ( const std::string &  ) const

virtual

virtual DistanceConversion DtScriptedMovementFileConfiguration::mapDistanceToInternalValue ( const std::string &  ) const

virtual

virtual double DtScriptedMovementFileConfiguration::convertDistanceToMeters ( double  d, DistanceConversion  conv  ) const

virtual

Converts distance units to meters given native format.

virtual DtString DtScriptedMovementFileConfiguration::toString ( ) const

virtual

Convert to a simple comma delimited string.

virtual void DtScriptedMovementFileConfiguration::fromString ( const DtString &  )

virtual

Convert back from comma delimeted string.

static DtScriptedMovementFileConfiguration DtScriptedMovementFileConfiguration::defaultConfiguration ( )

static

Returns a default configuration of 4 columns where the first column is time in seconds, second lateral distance in km, third is altitude in km and fourth is range in km.

Row start will also be set to 1 to account for a title line

virtual bool DtScriptedMovementFileConfiguration::setColumn ( int  col, const std::string &  type, const std::string &  unit, int  columnInFile = -1  )

virtual

Sets the information for the particular column.

If column does not exist will not set and return false. If columnInFile is -1 will keep current column setting, else set to new column

virtual void DtScriptedMovementFileConfiguration::column ( int  col, int &  columnInFile, std::string &  type, std::string &  unit  ) const

virtual

Retrieves information about the column.

template<class Archive >

void DtScriptedMovementFileConfiguration::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Serialization/Deserialization //.

Member Data Documentation

int DtScriptedMovementFileConfiguration::myRowStart

protected

Columns DtScriptedMovementFileConfiguration::myColumns

protected

int DtScriptedMovementFileConfiguration::myCachedColumns[4][2]

protected

Cache of column values.

Format of columns is column in file, conversion 0 - Time, 1 = lateral-distance, 2 = range, 3 = altitude

---

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

• include/vrfutil/scriptedMovementObject.h