End User Description: Actuator for moving aggregated aggregates along the ground. This actuator places the aggregate on the ground, moving it at some speed in the given direction. The aggregate is treated as a point object when moving using this actuator. Uses Descriptor Type: DtActuatorComponentDescriptor.

Inheritance diagram for DtAggregatedMovementActuator:

[legend]

Classes
class	ErrorStream

class	MobilityArea

Public Member Functions
	DtAggregatedMovementActuator (const DtString &name, DtLocalObject object, DtSimulationServices simManager, DtComponentDescriptor compDescriptor, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtAggregatedMovementActuator () override

virtual bool	init () override

virtual bool	createPSR ()

virtual const char *	type () const override

virtual void	tick () override

virtual void	setOrderedAltitude (double altitude, bool aboveGroundLevel=false)

Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent () override

virtual DtSimRadio *	radio ()

virtual bool	tickWhileDestroyed () const override

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent () override

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()

virtual void	registerAttributeFunctions ()

virtual void	preFirstTickInit ()

virtual void	postTick ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)

virtual void	setupFirstTickTime ()

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0) override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual void	isClutterChanged ()

virtual bool	taskVisualizationsActive () const

virtual bool	taskVisualizationsEnabled () const

virtual void	onRestore ()

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual void	updateImgui ()

virtual bool	debugActive () const

virtual void	enable ()

virtual void	disable ()

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () 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 const char *	readerWriterType () const

virtual const char *	xmlType () const

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	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 DtSimComponent *	creator (const DtString &name, DtLocalObject object, DtSimulationServices simManager, DtComponentDescriptor compDescriptor, DtReaderWriterRegistry parentRegistry)


static bool	setHaltMovementForObstacles (void controller, DtReaderWriter value)

static bool	setObstacleQueryName (void controller, DtReaderWriter value)

static DtReaderWriter *	isHalted (void *controller)

static DtReaderWriter *	blockingObstacle (void *controller)

static DtReaderWriter *	timeHalted (void *controller)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

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 Types
typedef MAKVRinTerra::DtFeatureSet	FeatureSet

typedef DtAggregatedMovementDescriptor::MobilityEntry	MobilityEntry

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Protected Member Functions
virtual DtVector	calculateProjectedLocation (const DtVector &oldLocalPosition, const DtVector &newBodyVelocity, double newHeading)

virtual std::string	calculateOrientationAndPosition (const DtVector &newLocalProjectedLocation, double newHeading, DtDcm &newLocalOrientation, DtVector &newLocalPosition)

virtual void	calculateFuelUsage (double distanceTraveled, double velocity, double altitude)

virtual std::string	adjustToTerrain (double heading, const DtVector &location, DtVector &newNormal)

virtual void	updateRepository (const DtVector &position, const DtVector &velocity, const DtVector &acceleration, const DtTaitBryan &localOrientation, const DtVector &rotationalVelocity)

virtual bool	isObstructedByObstacles (const MAKVRinTerra::DtFeatureGeometry &location)

virtual void	processObstacleToIgnore (DtSimMessage *msg)

virtual bool	createPorts () override

virtual bool	createPortGroups () override

virtual bool	haveSupplies (ErrorStream &errorStream) const

virtual double	scriptModifier () const

virtual double	scriptAdjustment () const

virtual double	maximumSpeedModifierFromFeatures (const MAKVRinTerra::DtFeatureGeometry &, double &slope) const

virtual double	retrogradeMovementModifier () const

	DtAggregatedMovementActuator (const DtAggregatedMovementActuator &orig)

const DtAggregatedMovementActuator &	operator= (const DtAggregatedMovementActuator &orig)

virtual bool	checkPassedDestination (const DtVector &currentPosition, DtVector &newLocalProjectedPosition)

virtual bool	setHaltMovementForObstacles (DtReaderWriter *value)

virtual bool	setObstacleQueryName (DtReaderWriter *value)

virtual void	setAircraftAirborne (const DtVector &location)

virtual DtReaderWriter *	isHalted ()

virtual DtReaderWriter *	blockingObstacle ()

virtual DtReaderWriter *	timeHalted ()

Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual void	setRadio (DtSimRadio *radio)

	DtActuatorComponent ()

Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)

virtual double	computeCurrentTime ()

bool	testInvariant () const

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	updateTaskVisualizations ()

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)

template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)

const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const

template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Member Functions
static void	setObstacleToIgnore (DtSimMessage msg, void usr)

Protected Attributes
DtVector	myPrep_oldLocalPosition

DtVector	myPrep_oldLocalVelocity

DtTaitBryan	myPrep_oldLocalOrientationTb

DtVector	myPrep_oldBodyVelocity

DtVector	myPrep_newLocalPosition

DtVector	myPrep_newRelativeVelocity

DtVector	myPrep_newBodyRotationalVelocity

DtTaitBryan	myPrep_newLocalOrientationTb

boost::optional< double >	myPrep_desiredAltitude

DtSetDataManager *	mySetDataManager

MobilityArea::Vector	myMobilityAreas

bool	myErrorCondition

std::unique_ptr< FeatureSet >	myEngineeringObjFeatureSet

std::unique_ptr< FeatureSet >	myEngineeringObjObstacleFeatureSet

DtBooleanInputPort *	myRetrogradeInputPort

DtAggregatedMovementActuatorPSR *	myProcessState

DtAggregateLocalObjectFacade	myAggregateLocalObjectFacade

Ports and Port Groups
DtAnalogInputPort *	myMovementDirectionInputPort

DtAnalogInputPort *	mySpeedInputPort

DtInputPortGroup *	myMovementControlPortGroupInputPortGroup

DtAnalogInputPort *	myAltitudeInputPort

DtVectorInputPort *	myDestinationInputPort


DtVrfMovingObjectStateRepository *	myMovingObjectStateRep


const DtActuatorComponentDescriptor *	myBaseActuatorDescriptor

const DtAggregatedMovementDescriptor *	myActuatorDescriptor

Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

bool	myLocalDebug

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 )()

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

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 MAKVRinTerra::DtFeatureSet DtAggregatedMovementActuator::FeatureSet

protected

Feature set type.

typedef DtAggregatedMovementDescriptor::MobilityEntry DtAggregatedMovementActuator::MobilityEntry

protected

Type which contains info on one type of mobility area.

Constructor & Destructor Documentation

DtAggregatedMovementActuator::DtAggregatedMovementActuator	(	const DtString &	name,
		DtLocalObject *	object,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	compDescriptor,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

virtual DtAggregatedMovementActuator::~DtAggregatedMovementActuator ( )

overridevirtual

destructor

DtAggregatedMovementActuator::DtAggregatedMovementActuator ( const DtAggregatedMovementActuator & orig )

protected

copy constructor

Member Function Documentation

virtual bool DtAggregatedMovementActuator::init ( )

overridevirtual

Perform any initialization required by the actuator.

Reimplemented from DtActuatorComponent.

Reimplemented in DtAirborneAggregatedMovementActuator.

virtual bool DtAggregatedMovementActuator::createPSR ( )

virtual

Creates the PSR to be used by this actuator.

virtual const char* DtAggregatedMovementActuator::type ( ) const

overridevirtual

Returns a string from simComponentTypes.h, identifying the type of component.

Implements DtSimComponent.

Reimplemented in DtAirborneAggregatedMovementActuator, and DtAggregatedSubsurfaceMovementActuator.

virtual void DtAggregatedMovementActuator::tick ( )

overridevirtual

Calculate new kinematic state, and copy it to state repository.

Reimplemented from DtSimComponent.

virtual void DtAggregatedMovementActuator::setOrderedAltitude	(	double	altitude,
		bool	aboveGroundLevel = `false`
	)

virtual

Sets the ordered altitude, in response to a set altitude command. If the ordered altitude is at or below the level of the terrain, then it is assumed that the intent is to land the entity, so SR->orderedAltitude is actually not set; instead, is-specified is set to false for orderedAltitude, and SR->amClampedToGround is set true. Otherwise, SR->amClampedToGround is set false.

Reimplemented in DtAggregatedSubsurfaceMovementActuator.

static DtSimComponent* DtAggregatedMovementActuator::creator	(	const DtString &	name,
		DtLocalObject *	object,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	compDescriptor,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Creator function to be registered with the DtSimComponentFactory – see main.cxx.

static bool DtAggregatedMovementActuator::setHaltMovementForObstacles	(	void *	controller,
		DtReaderWriter *	value
	)

static

Attribute functions:Function to be registered as a setter with the parent component system for the halt-movement-for-obstacles attribute. Calls setHaltMovementForObstacles(DtReaderWriter*)

static bool DtAggregatedMovementActuator::setObstacleQueryName	(	void *	controller,
		DtReaderWriter *	value
	)

static

Function to be registered as a setter with the parent component system for the obstacle-object-types attribute. Calls setObstacleQueryName(DtReaderWriter*)

static DtReaderWriter* DtAggregatedMovementActuator::isHalted ( void * controller )

static

Function to be registered as an attribute provider with the parent component system for the is-halted attribute. Calls isHalted()

static DtReaderWriter* DtAggregatedMovementActuator::blockingObstacle ( void * controller )

static

Function to be registered as an attribute provider with the parent component system for the blocking-obstacle attribute. Calls blockingObstacle()

static DtReaderWriter* DtAggregatedMovementActuator::timeHalted ( void * controller )

static

Function to be registered as an attribute provider with the parent component system for the time-halted attribute. Calls timeHalted()

virtual DtVector DtAggregatedMovementActuator::calculateProjectedLocation	(	const DtVector &	oldLocalPosition,
		const DtVector &	newBodyVelocity,
		double	newHeading
	)

protectedvirtual

virtual std::string DtAggregatedMovementActuator::calculateOrientationAndPosition	(	const DtVector &	newLocalProjectedLocation,
		double	newHeading,
		DtDcm &	newLocalOrientation,
		DtVector &	newLocalPosition
	)

protectedvirtual

Returns an error string.

Reimplemented in DtAggregatedSubsurfaceMovementActuator.

virtual void DtAggregatedMovementActuator::calculateFuelUsage	(	double	distanceTraveled,
		double	velocity,
		double	altitude
	)

protectedvirtual

Calculates the amount of fuel used. Implementation is responsible for setting appropriate properties from result.

Reimplemented in DtAirborneAggregatedMovementActuator.

virtual std::string DtAggregatedMovementActuator::adjustToTerrain	(	double	heading,
		const DtVector &	location,
		DtVector &	newNormal
	)

protectedvirtual

Returns an error string.

virtual void DtAggregatedMovementActuator::updateRepository	(	const DtVector &	position,
		const DtVector &	velocity,
		const DtVector &	acceleration,
		const DtTaitBryan &	localOrientation,
		const DtVector &	rotationalVelocity
	)

protectedvirtual

virtual bool DtAggregatedMovementActuator::isObstructedByObstacles ( const MAKVRinTerra::DtFeatureGeometry & location )

protectedvirtual

Returns true if movement to the specified location is obstructed by an obstacle in our path.

static void DtAggregatedMovementActuator::setObstacleToIgnore	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

Calls processSetObstacleToIgnore().

virtual void DtAggregatedMovementActuator::processObstacleToIgnore ( DtSimMessage * msg )

protectedvirtual

Adds a new obstacle to the list of obstacles to which should not cause the aggregate to halt.

virtual bool DtAggregatedMovementActuator::createPorts ( )

overrideprotectedvirtual

Overridden to create the movement control input ports.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMovementActuator::createPortGroups ( )

overrideprotectedvirtual

Overridden to create the movement control input port group.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMovementActuator::haveSupplies ( ErrorStream & errorStream ) const

protectedvirtual

Returns true if there are appropriate supplies to move. Checks Has-POL and Has-Food-Water in the state properties. If these properties are not found, they are assumed to be true.

virtual double DtAggregatedMovementActuator::scriptModifier ( ) const

protectedvirtual

Returns the modifier as calculated from the background movement modifier script. Looks at state property MaximumSpeedModifier. That property combines modifiers for rain, snow, wind, visibility, overlap (of footprint) with another unit, posture, and MOPP level.

virtual double DtAggregatedMovementActuator::scriptAdjustment ( ) const

protectedvirtual

Returns the adjustment as calculated from the background movement modifier script. Includes speed adjustments for wind direction.

virtual double DtAggregatedMovementActuator::maximumSpeedModifierFromFeatures	(	const MAKVRinTerra::DtFeatureGeometry &	,
		double &	slope
	)		const

protectedvirtual

Returns the modifier that is applied for the features multiplied by the modifier from the script. The slope will be overridden if any features override the slope of the terrain (e.g. bridges).

virtual double DtAggregatedMovementActuator::retrogradeMovementModifier ( ) const

protectedvirtual

Returns modifier for retrograde movement.

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

protected

assignment operator

virtual bool DtAggregatedMovementActuator::checkPassedDestination	(	const DtVector &	currentPosition,
		DtVector &	newLocalProjectedPosition
	)

protectedvirtual

If the destination input port is active then check to see if the new position will pass this destination. If it does then simply set the new local destination that which is specified on the port and return true.

virtual bool DtAggregatedMovementActuator::setHaltMovementForObstacles ( DtReaderWriter * value )

protectedvirtual

Sets the halt-movement-for-obstacles which tells the actuator to halt when it encounters obstacles in its path.

virtual bool DtAggregatedMovementActuator::setObstacleQueryName ( DtReaderWriter * value )

protectedvirtual

Sets the obstacle-query-name which tells the actuator what feature query represents obstacles to be halted for if halt-movement-for-obstacles is enabled.

virtual void DtAggregatedMovementActuator::setAircraftAirborne ( const DtVector & location )

protectedvirtual

Check the ground-clamped descriptor parameter to see if this is entity can go airborne. If so, then check to see if ordered-altitude has already been set. If not, set it at the minimum-airborne-altitude parameter and clear am-ground-clamped. Also, set the is-airborne state property. This function is called in tick() if the entity has moved (translated) this tick. The parameter is the entity's location.

Reimplemented in DtAggregatedSubsurfaceMovementActuator.

virtual DtReaderWriter* DtAggregatedMovementActuator::isHalted ( )

protectedvirtual

Returns the value of the is-halted attribute which indicates whether or not the aggregate is currently halted due to an engineering object obstacle in its path.

virtual DtReaderWriter* DtAggregatedMovementActuator::blockingObstacle ( )

protectedvirtual

Returns the value of the blocking-obstacle attribute which indicates the name of the engineering object obstacle causing movement to halt.

virtual DtReaderWriter* DtAggregatedMovementActuator::timeHalted ( )

protectedvirtual

Returns the value of the time-halted attribute which indicates the time at which movement was halted due to an engineering obstacle.

Member Data Documentation

DtVector DtAggregatedMovementActuator::myPrep_oldLocalPosition

protected

Values preprocessed for use in tick /////////////////////!

DtVector DtAggregatedMovementActuator::myPrep_oldLocalVelocity

protected

DtTaitBryan DtAggregatedMovementActuator::myPrep_oldLocalOrientationTb

protected

DtVector DtAggregatedMovementActuator::myPrep_oldBodyVelocity

protected

DtVector DtAggregatedMovementActuator::myPrep_newLocalPosition

protected

DtVector DtAggregatedMovementActuator::myPrep_newRelativeVelocity

protected

DtVector DtAggregatedMovementActuator::myPrep_newBodyRotationalVelocity

protected

DtTaitBryan DtAggregatedMovementActuator::myPrep_newLocalOrientationTb

protected

boost::optional<double> DtAggregatedMovementActuator::myPrep_desiredAltitude

protected

DtAnalogInputPort* DtAggregatedMovementActuator::myMovementDirectionInputPort

protected

Input Port Name: desired-movement-direction
Input Port Description: Desired movement direction of the entity in radians.
Input Port Range: 0 - 2*pi
Input Port Default Value: N/A
Input Group Parent: movement-control.

DtAnalogInputPort* DtAggregatedMovementActuator::mySpeedInputPort

protected

Input Port Name: desired-speed
Input Port Description: Desired speed of the entity in m/s.
Input Port Range: 0 and up. Input Port Default Value: N/A
Input Group Parent: movement-control.

DtInputPortGroup* DtAggregatedMovementActuator::myMovementControlPortGroupInputPortGroup

protected

Input Port Group Name: movement-control
Input Port Group Description: Collection of inputs specifying the desired movement of the entity.
.

DtAnalogInputPort* DtAggregatedMovementActuator::myAltitudeInputPort

protected

Input Port Name: desired-altitude
Input Port Description: Desired altitude to move towards (MSL).
Input Port Range:
Input Port Default Value: N/A
Input Group Parent:
.

DtVectorInputPort* DtAggregatedMovementActuator::myDestinationInputPort

protected

Output Port Name: destination
Output Port Description: Specifies the current destination of the entity in geocentric coordinates. Output Port Range:
Output Group Parent:
.

DtVrfMovingObjectStateRepository* DtAggregatedMovementActuator::myMovingObjectStateRep

protected

Convenience pointers to our state repository.

const DtActuatorComponentDescriptor* DtAggregatedMovementActuator::myBaseActuatorDescriptor

protected

Convenience pointers to our descriptors.

const DtAggregatedMovementDescriptor* DtAggregatedMovementActuator::myActuatorDescriptor

protected

Convenience pointers to our descriptors.

DtSetDataManager* DtAggregatedMovementActuator::mySetDataManager

protected

Ref to set data manager.

MobilityArea::Vector DtAggregatedMovementActuator::myMobilityAreas

protected

List of mobility areas.

bool DtAggregatedMovementActuator::myErrorCondition

protected

Set to true once the error stream message is displayed, so we don't display over and over.

std::unique_ptr<FeatureSet> DtAggregatedMovementActuator::myEngineeringObjFeatureSet

protected

Set of engineering object features that can affect mobility.

std::unique_ptr<FeatureSet> DtAggregatedMovementActuator::myEngineeringObjObstacleFeatureSet

protected

Set of engineering object features that should be considered obstacles for which we should halt.

DtBooleanInputPort* DtAggregatedMovementActuator::myRetrogradeInputPort

protected

DtAggregatedMovementActuatorPSR* DtAggregatedMovementActuator::myProcessState

protected

Pointer to a process state repository used to store state data associated with this component.

DtAggregateLocalObjectFacade DtAggregatedMovementActuator::myAggregateLocalObjectFacade

protected

Member to allow for access to aggregate specific data.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/aggregatedMovementActuator.h

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation