DtRwScenarioEvent Class Reference

The DtRwScenarioEvent class will define the contents of a scenario event and it's current status. It will also be used to initially create an event.

Inheritance diagram for DtRwScenarioEvent:

Classes
struct	PredecessorItem

Public Types
typedef std::vector < PredecessorItem >	PredecessorList
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtRwScenarioEvent (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwScenarioEvent (const DtRwScenarioEvent &orig, DtReaderWriterRegistry *parentRegistry=0)
DtRwScenarioEvent &	operator= (const DtRwScenarioEvent &orig)
virtual	~DtRwScenarioEvent ()
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual const DtString &	caption () const
virtual void	setCaption (const DtString &input)
virtual int	endTimeType () const
virtual void	setEndTimeType (int input)
virtual double	endTimeValue () const
virtual void	setEndTimeValue (double tValue)
virtual double	simTimeEnded () const
virtual void	setSimTimeEnded (double tValue)
virtual const DtNLengthIntegerVector &	forces () const
virtual void	addForce (int input)
virtual void	removeForce (int)
virtual void	setForces (const DtNLengthIntegerVector &)
virtual bool	isAvailableToForce (int) const
virtual bool	isAvailableToForce (const std::vector< int > &) const
virtual void	clearForces ()
virtual const unsigned int	forcePermissionMask () const
virtual void	setForcePermissionMask (int input)
virtual const DtVector &	location () const
virtual void	setLocation (const DtVector &input)
virtual bool	isLocationSet () const
virtual void	setLocationIsSet (bool isSet)
virtual DtString	symbolFile () const
virtual void	setSymbolFile (const DtString &input)
virtual const DtString &	mediaText () const
virtual void	setMediaText (const DtString &input)
virtual const DtString &	mediaSound () const
virtual void	setMediaSound (const DtString &input)
virtual const DtString &	mediaVideo () const
virtual void	setMediaVideo (const DtString &input)
virtual const DtString &	mediaPicture () const
virtual void	setMediaPicture (const DtString &input)
virtual const DtString &	multipleChoiceQuiz () const
virtual void	setMultipleChoiceQuiz (const DtString &input)
virtual int	ordinal () const
virtual void	setOrdinal (int nOrd)
virtual void	setEnabled (bool)
virtual bool	enabled () const
virtual void	setEnabledStateLinkedTo (const DtUUID &)
virtual const DtUUID &	enabledStateLinkedTo () const
virtual void	addToPredecessorList (const DtUUID &pUniqueID, int predType=DtSEPredecessorType_Concluded)
virtual PredecessorList	predecessorList () const
virtual void	setPredecessorList (const PredecessorList &)
virtual void	clearPredecessorList ()
virtual void	removeFromPredecessorList (const DtUUID &pUniqueID)
virtual bool	resolved () const
virtual void	setResolved (bool input)
virtual int	startTimeType () const
virtual void	setStartTimeType (int input)
virtual DtString	startTimeString () const
virtual double	startTimeValue () const
virtual void	setStartTimeValue (double tValue)
virtual bool	isQuickLaunch () const
virtual void	setIsQuickLaunch (bool)
virtual void	setScaledPicture (bool)
virtual bool	scaledPicture () const
virtual double	simTimeStarted () const
virtual void	setSimTimeStarted (double tValue)
virtual int	triggerStatus () const
virtual void	setTriggerStatus (int input)
virtual const DtUUID &	uniqueId () const
virtual void	setUniqueId (const DtUUID &input)
virtual double	version () const
virtual void	setVersion (double input)
virtual double	predecessorDeltaValue () const
virtual void	setPredecessorDeltaValue (double delta)
virtual void	addSensorSignature (const DtString &, double val)
virtual void	removeSensorSignature (const DtString &)
virtual void	setSensorSignatures (const std::map< std::string, double > &)
virtual std::map< std::string, double >	sensorSignatures () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwString	myCaption
DtRwInt	myEndTimeType
DtRwReal	myEndTime
DtRwInt	myStartTimeType
DtRwReal	myStartTime
DtNLengthIntegerVector	myForces
DtRwInt	myForcePermissionMask
DtRwVector	myLocation
DtRwBoolean	myUseLocation
DtRwString	mySymbolFile
DtRwString	myMediaText
DtRwString	myMediaVideo
DtRwString	myMediaSound
DtRwString	myMediaPicture
DtRwString	myMultipleChoiceQuiz
DtRwInt	myOrdinal
DtRwString	myPredecessorList
DtRwBoolean	myResolved
DtRwInt	myTriggerStatus
DtRwScenarioEventUUID	myUniqueId
DtRwInt	myVersion
DtRwReal	myPredecessorDeltaValue
DtRwReal	mySimTimeStarted
DtRwReal	mySimTimeEnded
DtRwBoolean	myIsQuickLaunch
DtRwBoolean	myScaledPicture
DtRwUUID	myEnabledStateLinkedTo
DtRwBoolean	myEnabled
DtRwString	mySensorSignatures
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtRwScenarioEvent ()

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Member Typedef Documentation

typedef std::vector<PredecessorItem> DtRwScenarioEvent::PredecessorList

Constructor & Destructor Documentation

DtRwScenarioEvent::DtRwScenarioEvent	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtRwScenarioEvent::DtRwScenarioEvent	(	const DtRwScenarioEvent &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtRwScenarioEvent::~DtRwScenarioEvent ( )

virtual

destructor

DtRwScenarioEvent::DtRwScenarioEvent ( )

private

default constructor; not implemented

Member Function Documentation

DtRwScenarioEvent& DtRwScenarioEvent::operator=

(

const DtRwScenarioEvent &

orig

)

assignment

virtual const char* DtRwScenarioEvent::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* DtRwScenarioEvent::theXmlType ( )

static

virtual const char* DtRwScenarioEvent::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual const DtString& DtRwScenarioEvent::caption ( ) const

virtual

virtual void DtRwScenarioEvent::setCaption ( const DtString &  input )

virtual

virtual int DtRwScenarioEvent::endTimeType ( ) const

virtual

virtual void DtRwScenarioEvent::setEndTimeType ( int  input )

virtual

virtual double DtRwScenarioEvent::endTimeValue ( ) const

virtual

virtual void DtRwScenarioEvent::setEndTimeValue ( double  tValue )

virtual

virtual double DtRwScenarioEvent::simTimeEnded ( ) const

virtual

virtual void DtRwScenarioEvent::setSimTimeEnded ( double  tValue )

virtual

virtual const DtNLengthIntegerVector& DtRwScenarioEvent::forces ( ) const

virtual

virtual void DtRwScenarioEvent::addForce ( int  input )

virtual

virtual void DtRwScenarioEvent::removeForce ( int  )

virtual

virtual void DtRwScenarioEvent::setForces ( const DtNLengthIntegerVector &  )

virtual

virtual bool DtRwScenarioEvent::isAvailableToForce ( int  ) const

virtual

virtual bool DtRwScenarioEvent::isAvailableToForce ( const std::vector< int > &  ) const

virtual

virtual void DtRwScenarioEvent::clearForces ( )

virtual

virtual const unsigned int DtRwScenarioEvent::forcePermissionMask ( ) const

virtual

virtual void DtRwScenarioEvent::setForcePermissionMask ( int  input )

virtual

virtual const DtVector& DtRwScenarioEvent::location ( ) const

virtual

virtual void DtRwScenarioEvent::setLocation ( const DtVector &  input )

virtual

virtual bool DtRwScenarioEvent::isLocationSet ( ) const

virtual

virtual void DtRwScenarioEvent::setLocationIsSet ( bool  isSet )

virtual

virtual DtString DtRwScenarioEvent::symbolFile ( ) const

virtual

virtual void DtRwScenarioEvent::setSymbolFile ( const DtString &  input )

virtual

virtual const DtString& DtRwScenarioEvent::mediaText ( ) const

virtual

virtual void DtRwScenarioEvent::setMediaText ( const DtString &  input )

virtual

virtual const DtString& DtRwScenarioEvent::mediaSound ( ) const

virtual

virtual void DtRwScenarioEvent::setMediaSound ( const DtString &  input )

virtual

virtual const DtString& DtRwScenarioEvent::mediaVideo ( ) const

virtual

virtual void DtRwScenarioEvent::setMediaVideo ( const DtString &  input )

virtual

virtual const DtString& DtRwScenarioEvent::mediaPicture ( ) const

virtual

virtual void DtRwScenarioEvent::setMediaPicture ( const DtString &  input )

virtual

virtual const DtString& DtRwScenarioEvent::multipleChoiceQuiz ( ) const

virtual

virtual void DtRwScenarioEvent::setMultipleChoiceQuiz ( const DtString &  input )

virtual

virtual int DtRwScenarioEvent::ordinal ( ) const

virtual

virtual void DtRwScenarioEvent::setOrdinal ( int  nOrd )

virtual

virtual void DtRwScenarioEvent::setEnabled ( bool  )

virtual

virtual bool DtRwScenarioEvent::enabled ( ) const

virtual

virtual void DtRwScenarioEvent::setEnabledStateLinkedTo ( const DtUUID &  )

virtual

virtual const DtUUID& DtRwScenarioEvent::enabledStateLinkedTo ( ) const

virtual

virtual void DtRwScenarioEvent::addToPredecessorList ( const DtUUID &  pUniqueID, int  predType = DtSEPredecessorType_Concluded  )

virtual

virtual PredecessorList DtRwScenarioEvent::predecessorList ( ) const

virtual

virtual void DtRwScenarioEvent::setPredecessorList ( const PredecessorList &  )

virtual

virtual void DtRwScenarioEvent::clearPredecessorList ( )

virtual

virtual void DtRwScenarioEvent::removeFromPredecessorList ( const DtUUID &  pUniqueID )

virtual

virtual bool DtRwScenarioEvent::resolved ( ) const

virtual

virtual void DtRwScenarioEvent::setResolved ( bool  input )

virtual

virtual int DtRwScenarioEvent::startTimeType ( ) const

virtual

virtual void DtRwScenarioEvent::setStartTimeType ( int  input )

virtual

virtual DtString DtRwScenarioEvent::startTimeString ( ) const

virtual

virtual double DtRwScenarioEvent::startTimeValue ( ) const

virtual

virtual void DtRwScenarioEvent::setStartTimeValue ( double  tValue )

virtual

virtual bool DtRwScenarioEvent::isQuickLaunch ( ) const

virtual

virtual void DtRwScenarioEvent::setIsQuickLaunch ( bool  )

virtual

virtual void DtRwScenarioEvent::setScaledPicture ( bool  )

virtual

virtual bool DtRwScenarioEvent::scaledPicture ( ) const

virtual

virtual double DtRwScenarioEvent::simTimeStarted ( ) const

virtual

virtual void DtRwScenarioEvent::setSimTimeStarted ( double  tValue )

virtual

virtual int DtRwScenarioEvent::triggerStatus ( ) const

virtual

virtual void DtRwScenarioEvent::setTriggerStatus ( int  input )

virtual

virtual const DtUUID& DtRwScenarioEvent::uniqueId ( ) const

virtual

virtual void DtRwScenarioEvent::setUniqueId ( const DtUUID &  input )

virtual

virtual double DtRwScenarioEvent::version ( ) const

virtual

virtual void DtRwScenarioEvent::setVersion ( double  input )

virtual

virtual double DtRwScenarioEvent::predecessorDeltaValue ( ) const

virtual

virtual void DtRwScenarioEvent::setPredecessorDeltaValue ( double  delta )

virtual

virtual void DtRwScenarioEvent::addSensorSignature ( const DtString &  , double  val  )

virtual

@( Manages sensor signatures for intelligence objects. The sensor signature must be as it appears in the back-end sensor signature factory (for example, visual, infrared)

virtual void DtRwScenarioEvent::removeSensorSignature ( const DtString &  )

virtual

virtual void DtRwScenarioEvent::setSensorSignatures ( const std::map< std::string, double > &  )

virtual

virtual std::map<std::string, double> DtRwScenarioEvent::sensorSignatures ( ) const

virtual

Member Data Documentation

DtRwString DtRwScenarioEvent::myCaption

protected

DtRwInt DtRwScenarioEvent::myEndTimeType

protected

DtRwReal DtRwScenarioEvent::myEndTime

protected

DtRwInt DtRwScenarioEvent::myStartTimeType

protected

DtRwReal DtRwScenarioEvent::myStartTime

protected

DtNLengthIntegerVector DtRwScenarioEvent::myForces

protected

DtRwInt DtRwScenarioEvent::myForcePermissionMask

protected

DtRwVector DtRwScenarioEvent::myLocation

protected

DtRwBoolean DtRwScenarioEvent::myUseLocation

protected

DtRwString DtRwScenarioEvent::mySymbolFile

protected

DtRwString DtRwScenarioEvent::myMediaText

protected

DtRwString DtRwScenarioEvent::myMediaVideo

protected

DtRwString DtRwScenarioEvent::myMediaSound

protected

DtRwString DtRwScenarioEvent::myMediaPicture

protected

DtRwString DtRwScenarioEvent::myMultipleChoiceQuiz

protected

DtRwInt DtRwScenarioEvent::myOrdinal

protected

DtRwString DtRwScenarioEvent::myPredecessorList

protected

DtRwBoolean DtRwScenarioEvent::myResolved

protected

DtRwInt DtRwScenarioEvent::myTriggerStatus

protected

DtRwScenarioEventUUID DtRwScenarioEvent::myUniqueId

protected

DtRwInt DtRwScenarioEvent::myVersion

protected

DtRwReal DtRwScenarioEvent::myPredecessorDeltaValue

protected

DtRwReal DtRwScenarioEvent::mySimTimeStarted

protected

DtRwReal DtRwScenarioEvent::mySimTimeEnded

protected

DtRwBoolean DtRwScenarioEvent::myIsQuickLaunch

protected

DtRwBoolean DtRwScenarioEvent::myScaledPicture

protected

DtRwUUID DtRwScenarioEvent::myEnabledStateLinkedTo

protected

DtRwBoolean DtRwScenarioEvent::myEnabled

protected

DtRwString DtRwScenarioEvent::mySensorSignatures

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/rwScenarioEvent.h