DtRefuelPoint is a readable/writable triplet of a refuel point's name, position offset, and enabled state. It describes the list of refuel points that can be used to transfer fuel from the Supplier to the Reciever in air-to-air refueling.

Inheritance diagram for DtRefuelPoint:

[legend]

Public Member Functions
	DtRefuelPoint ()

	DtRefuelPoint (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRefuelPoint (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRefuelPoint (const DtRefuelPoint &orig)

	DtRefuelPoint (const DtString &name, const DtRefuelPoint &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRefuelPoint (const DtSymbolString &name, const DtRefuelPoint &orig, DtReaderWriterRegistry *parentRegistry=NULL)

const DtRefuelPoint &	operator= (const DtRefuelPoint &orig)

virtual	~DtRefuelPoint ()

virtual DtRefuelPoint *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtRefuelPoint *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

bool	operator== (const DtRefuelPoint &) const

bool	operator!= (const DtRefuelPoint &rhs) const


virtual const bool	isPointEnabled () const

virtual void	setPointEnabled (const bool state)


virtual const int	pointPart () const

virtual void	setPointPart (const int pointPart)


virtual const DtVectorOffset3D	pointOffset () const

virtual void	setPointOffset (const DtVectorOffset3D &offset)


virtual const DtString &	pointType () 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) const

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
parameters
These parameters are available for setting in the sysdef files.
DtRwBoolean	myRefuelPointState

DtRwInt	myRefuelPointPart

DtRwOffsetVector	myRefuelPointOffset

DtRwString	myRefuelPointType

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

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

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

Constructor & Destructor Documentation

DtRefuelPoint::DtRefuelPoint ( )

default constructor

DtRefuelPoint::DtRefuelPoint	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

DtRefuelPoint::DtRefuelPoint	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtRefuelPoint::DtRefuelPoint ( const DtRefuelPoint & orig )

copy constructor

DtRefuelPoint::DtRefuelPoint	(	const DtString &	name,
		const DtRefuelPoint &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtRefuelPoint::DtRefuelPoint	(	const DtSymbolString &	name,
		const DtRefuelPoint &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtRefuelPoint::~DtRefuelPoint ( )

virtual

Member Function Documentation

const DtRefuelPoint& DtRefuelPoint::operator= ( const DtRefuelPoint & orig )

assignment operator

virtual DtRefuelPoint* DtRefuelPoint::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual DtRefuelPoint* DtRefuelPoint::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual const bool DtRefuelPoint::isPointEnabled ( ) const

virtual

Accessor/mutator for myRefuelPointState.

virtual void DtRefuelPoint::setPointEnabled ( const bool state )

virtual

Accessor/mutator for myRefuelPointState.

virtual const int DtRefuelPoint::pointPart ( ) const

virtual

Accessor/mutator for myRefuelPointPart To define whether the point is the Port, Starboard or Centerline refueling point based on the articulated part number.

virtual void DtRefuelPoint::setPointPart ( const int pointPart )

virtual

Accessor/mutator for myRefuelPointPart To define whether the point is the Port, Starboard or Centerline refueling point based on the articulated part number.

virtual const DtVectorOffset3D DtRefuelPoint::pointOffset ( ) const

virtual

Accessor/mutator for #myRefuelPointOffest.

virtual void DtRefuelPoint::setPointOffset ( const DtVectorOffset3D & offset )

virtual

Accessor/mutator for #myRefuelPointOffest.

virtual const DtString& DtRefuelPoint::pointType ( ) const

virtual

Accessor for myRefuelPointType.

virtual const char* DtRefuelPoint::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* DtRefuelPoint::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtRefuelPoint::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

bool DtRefuelPoint::operator== ( const DtRefuelPoint & ) const

bool DtRefuelPoint::operator!= ( const DtRefuelPoint & rhs ) const

inline

Member Data Documentation

DtRwBoolean DtRefuelPoint::myRefuelPointState

protected

Parameter Name: refuel-point-enabled
Parameter Description: Whether the refuel point is enabled or disabled.
.

DtRwInt DtRefuelPoint::myRefuelPointPart

protected

Parameter Name: refuel-point-part
Parameter Description: The art part of the refuel point.
.

DtRwOffsetVector DtRefuelPoint::myRefuelPointOffset

protected

Parameter Name: refuel-point-offset
Parameter Description: The vector offset at which the refuel position is located.
.

DtRwString DtRefuelPoint::myRefuelPointType

protected

Parameter Name: refuel-point-type
Parameter Description: Whether the refuel point is a boom or drogue.
.

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation