DtMissileFlightPSR Class Reference

class DtMissileFlightPSR: More...

Inheritance diagram for DtMissileFlightPSR:

Public Member Functions
	DtMissileFlightPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtMissileFlightPSR (const DtMissileFlightPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor - not implemented
virtual	~DtMissileFlightPSR ()
	destructor
DtMissileFlightPSR &	operator= (const DtMissileFlightPSR &orig)
	assignment operator - not implemented
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	setMaxBurnTime (DtTime seconds)
	Set/get the maximum burn time (seconds).
virtual DtTime	maxBurnTime () const
virtual void	setMaxBurnTimeSet (bool flag)
	Set/get flag indicating whether max burn time has been set.
virtual bool	maxBurnTimeSet () const
virtual void	setCurrentBurnTime (DtTime seconds)
	Set/get current burn time (seconds).
virtual DtTime	currentBurnTime () const
virtual void	setTargetPoint (const DtVector &targetPoint)
	Set/get the target point location.
virtual const DtVector &	targetPoint () const
virtual bool	isMissileTargetted () const
	Get flag indicating whether missile target has been set.
virtual void	setTargetVelocity (const DtVector &velocity)
	Set/get the current target velocity for the missile.
virtual const DtVector &	targetVelocity () const
virtual void	setTargetEntity (const DtString &objectName)
	Set/get the object name of the target entity.
virtual const DtString &	targetEntity () const
virtual void	setLaunchPhase (DtMissileLaunchPhase phase)
	Set/get the launch phase we're in (simple target acquisition or proportional navigation).
virtual DtMissileLaunchPhase	launchPhase () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Attributes
DtRwBoolean	myMaxBurnTimeSet
	Moved here from DtMissileManeuverActComponent (msslManeuvAct.h)
DtRwReal	myMaxBurnTime
	Maximum burn time (range/maximum speed, in seconds).
DtRwReal	myCurrentBurnTime
	Current burn time remaining (in seconds).
DtRwVector	myTargetPoint
	Moved here from DtMissileMoveToControllerComponent (msslMvToCntlr.h)
DtRwVector	myTargetVelocity
	Target velocity (meters/seconds, database coordinates)
DtRwBoolean	myIsMissileTargetted
	Flag indicating whether missile has a designated target.
DtRwString	myEntityToTrack
	Moved here from DtMissileTrackEntityController.
DtRwInt	myLaunchPhase
	Launch phase.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtMissileFlightPSR:

Instances of DtMissileFlightPSR are

Instances of DtRotaryWingFlightPSR are used to hold the shared/checkpointable state data associated with the process of missile flight.

Constructor & Destructor Documentation

DtMissileFlightPSR::DtMissileFlightPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtMissileFlightPSR::DtMissileFlightPSR	(	const DtMissileFlightPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor - not implemented

virtual DtMissileFlightPSR::~DtMissileFlightPSR ( )

virtual

destructor

Member Function Documentation

DtMissileFlightPSR& DtMissileFlightPSR::operator=

(

const DtMissileFlightPSR &

orig

)

assignment operator - not implemented

virtual DtVrfProcessStateRepository* DtMissileFlightPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtMissileFlightPSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

(DtVrfRotaryWingFlightProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtMissileFlightPSR::setMaxBurnTime ( DtTime  seconds )

virtual

Set/get the maximum burn time (seconds).

virtual DtTime DtMissileFlightPSR::maxBurnTime ( ) const

virtual

virtual void DtMissileFlightPSR::setMaxBurnTimeSet ( bool  flag )

virtual

Set/get flag indicating whether max burn time has been set.

virtual bool DtMissileFlightPSR::maxBurnTimeSet ( ) const

virtual

virtual void DtMissileFlightPSR::setCurrentBurnTime ( DtTime  seconds )

virtual

Set/get current burn time (seconds).

virtual DtTime DtMissileFlightPSR::currentBurnTime ( ) const

virtual

virtual void DtMissileFlightPSR::setTargetPoint ( const DtVector &  targetPoint )

virtual

Set/get the target point location.

virtual const DtVector& DtMissileFlightPSR::targetPoint ( ) const

virtual

virtual bool DtMissileFlightPSR::isMissileTargetted ( ) const

virtual

Get flag indicating whether missile target has been set.

virtual void DtMissileFlightPSR::setTargetVelocity ( const DtVector &  velocity )

virtual

Set/get the current target velocity for the missile.

virtual const DtVector& DtMissileFlightPSR::targetVelocity ( ) const

virtual

virtual void DtMissileFlightPSR::setTargetEntity ( const DtString &  objectName )

virtual

Set/get the object name of the target entity.

virtual const DtString& DtMissileFlightPSR::targetEntity ( ) const

virtual

virtual void DtMissileFlightPSR::setLaunchPhase ( DtMissileLaunchPhase  phase )

virtual

Set/get the launch phase we're in (simple target acquisition or proportional navigation).

virtual DtMissileLaunchPhase DtMissileFlightPSR::launchPhase ( ) const

virtual

static DtVrfProcessStateRepository* DtMissileFlightPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtMissileFlightPSR::myMaxBurnTimeSet

protected

Moved here from DtMissileManeuverActComponent (msslManeuvAct.h)

Flag indicating whether the maximum burn time has been set.

DtRwReal DtMissileFlightPSR::myMaxBurnTime

protected

Maximum burn time (range/maximum speed, in seconds).

DtRwReal DtMissileFlightPSR::myCurrentBurnTime

protected

Current burn time remaining (in seconds).

DtRwVector DtMissileFlightPSR::myTargetPoint

protected

Moved here from DtMissileMoveToControllerComponent (msslMvToCntlr.h)

Target point (meters, database coordinates).

DtRwVector DtMissileFlightPSR::myTargetVelocity

protected

Target velocity (meters/seconds, database coordinates)

DtRwBoolean DtMissileFlightPSR::myIsMissileTargetted

protected

Flag indicating whether missile has a designated target.

DtRwString DtMissileFlightPSR::myEntityToTrack

protected

Moved here from DtMissileTrackEntityController.

The object name of the entity I'm tracking.

DtRwInt DtMissileFlightPSR::myLaunchPhase

protected

Launch phase.

Starts at one for simple target acquisition navigation, then gets set to two to begin proportional navigation when the target is within the missile's acquisition angle. Any other values are ignored by calculateSteering().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/missileFlightPSR.h