DtTranslatablePartActuator is a simple actuator which controls the movement of an articulated part as it moves from minimum elevation to maximum elevation. More...

Inheritance diagram for DtTranslatablePartActuator:

[legend]

Public Member Functions
	DtTranslatablePartActuator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
virtual	~DtTranslatablePartActuator ()
	destructor
virtual bool	init ()
	Overridden to cache a pointer to the entity's radio in this class.
virtual bool	postAddComponentsInit ()
	Overridden to set the values on myAzimuthInfoPortGroup.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Calculate new kinematic state.
virtual void	bindLuaFunctions (lua_State *L)
	Binds method for this class to the lua state.
virtual void	bindLuaGlobals (lua_State *L)
	Override to bind lua globals.

virtual void	lower ()
virtual void	raise ()
	Raise part to maximum.
virtual void	left ()
	Move part in negative direction on X axis to minimum.
virtual void	right ()
	Move part in positive direction on X axis to maximum.
virtual void	forward ()
	Move part in positive direction on Y axis to maximum.
virtual void	backward ()
	Move part in negative direction on Y axis to minimum.
virtual void	stop ()
	Stops lowering or raising the part.
virtual void	pause ()
	Pauses the translation of the part.
virtual void	resume ()
	Resumes movement if there is movement paused.
virtual bool	isFullyTranslatedToMaximum () const
	Returns true if the part is in the fully translated to maximum position.
virtual bool	isFullyTranslatedToMinimum () const
	Returns true if the part is in the fully translated to minimum position.
virtual int	state () const
	Returns the current state 1 - Being lowered 2 - Being raised 3 - Being moved left 4 - Being moved right 5 - Being moved forward 6 - Being moved backward.
virtual bool	paused () const
	Returns whether or not part is in paused state.
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
virtual bool	tickWhileDestroyed () const
	By default, all actuators tick when the entity is destroyed.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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.
Public Member Functions inherited from DtBindableLuaComponent< DtTranslatablePartActuator >
	DtBindableLuaComponent (const DtVrfObject *entity, const DtString &componentName, const DtString &componentType)
virtual	~DtBindableLuaComponent ()
bool	shouldBind (lua_State *L) const
Public Member Functions inherited from DtBindableLuaComponentInterface
	DtBindableLuaComponentInterface (const DtVrfObject *entity, const DtString &componentName, const DtString &componentType)
	CTOR.
virtual	~DtBindableLuaComponentInterface ()
	DTOR.
virtual void	bind (DtVrfObject , const DtString &scriptId, lua_State )
	Starts the binding process.
virtual DtString	bindableName (const DtString &) const
	Returns a name suitable for binding. Replaces spaces and - with _.

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,

Protected Member Functions
virtual DtTranslatablePartActuatorPSR *	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual double	currentPosition ()
virtual void	setPositionAndRate (double newPos, double newRate)
	Sets the new angle and rate of the articulated part.
virtual void	updatePartState ()
	Updates the information that will get updated for the part on the network as to the current translation state.
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
	DtActuatorComponent (const DtActuatorComponent &orig)
	copy constructor
const DtActuatorComponent &	operator= (const DtActuatorComponent &orig)
	assignment operator
virtual void	setRadio (DtSimBaseRadio *radio)
	DtActuatorComponent ()
	Default constructor; should not be called.
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes

DtArticulatedPartStateRepository *	myArtPartStateRep
const DtTranslatablePartActuatorDescriptor *	myDescriptor
DtTranslatablePartActuatorPSR *	myProcessState
Protected Attributes inherited from DtActuatorComponent
DtSimBaseRadio *	myRadio
	Actuators can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
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.

Private Member Functions
	DtTranslatablePartActuator ()
	default constructor; not implemented
	DtTranslatablePartActuator (const DtTranslatablePartActuator &orig)
	copy constructor; not implemented
const DtTranslatablePartActuator &	operator= (const DtTranslatablePartActuator &orig)
	assignment operator; not implemented

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 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
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtTranslatablePartActuator is a simple actuator which controls the movement of an articulated part as it moves from minimum elevation to maximum elevation.

Call "translateUp" to start translating the part in a positive direction, "translateDown" to start translating the part in a negative direction and "pause" to pause the raising of the part at the current position. Call "resume" to resume either the last translate command

Uses Descriptor Type: DtTranslatablePartActuatorDescriptor

Constructor & Destructor Documentation

DtTranslatablePartActuator::DtTranslatablePartActuator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtTranslatablePartActuator::~DtTranslatablePartActuator ( )

virtual

destructor

DtTranslatablePartActuator::DtTranslatablePartActuator ( )

private

default constructor; not implemented

DtTranslatablePartActuator::DtTranslatablePartActuator ( const DtTranslatablePartActuator & orig )

private

copy constructor; not implemented

Member Function Documentation

virtual bool DtTranslatablePartActuator::init ( )

virtual

Overridden to cache a pointer to the entity's radio in this class.

Reimplemented from DtActuatorComponent.

virtual bool DtTranslatablePartActuator::postAddComponentsInit ( )

virtual

Overridden to set the values on myAzimuthInfoPortGroup.

Reimplemented from DtSimComponent.

virtual DtString DtTranslatablePartActuator::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns: DtTranslatablePartActuatorType

Reimplemented from DtSimComponent.

virtual void DtTranslatablePartActuator::tick ( )

virtual

Calculate new kinematic state.

Reimplemented from DtSimComponent.

static DtSimComponent* DtTranslatablePartActuator::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns: New instance of this class.

virtual void DtTranslatablePartActuator::lower ( )

virtual

Methods accesible via Lua extensions Lower part to minimum

virtual void DtTranslatablePartActuator::raise ( )

virtual

Raise part to maximum.

virtual void DtTranslatablePartActuator::left ( )

virtual

Move part in negative direction on X axis to minimum.

virtual void DtTranslatablePartActuator::right ( )

virtual

Move part in positive direction on X axis to maximum.

virtual void DtTranslatablePartActuator::forward ( )

virtual

Move part in positive direction on Y axis to maximum.

virtual void DtTranslatablePartActuator::backward ( )

virtual

Move part in negative direction on Y axis to minimum.

virtual void DtTranslatablePartActuator::stop ( )

virtual

Stops lowering or raising the part.

virtual void DtTranslatablePartActuator::pause ( )

virtual

Pauses the translation of the part.

virtual void DtTranslatablePartActuator::resume ( )

virtual

Resumes movement if there is movement paused.

virtual bool DtTranslatablePartActuator::isFullyTranslatedToMaximum ( ) const

virtual

Returns true if the part is in the fully translated to maximum position.

virtual bool DtTranslatablePartActuator::isFullyTranslatedToMinimum ( ) const

virtual

Returns true if the part is in the fully translated to minimum position.

virtual int DtTranslatablePartActuator::state ( ) const

virtual

Returns the current state 1 - Being lowered 2 - Being raised 3 - Being moved left 4 - Being moved right 5 - Being moved forward 6 - Being moved backward.

virtual bool DtTranslatablePartActuator::paused ( ) const

virtual

Returns whether or not part is in paused state.

virtual void DtTranslatablePartActuator::bindLuaFunctions ( lua_State * L )

virtual

Binds method for this class to the lua state.

This simple method will send an object console message to the entity that implements this task

Implements DtBindableLuaComponentInterface.

virtual void DtTranslatablePartActuator::bindLuaGlobals ( lua_State * )

virtual

Override to bind lua globals.

Implements DtBindableLuaComponentInterface.

virtual DtTranslatablePartActuatorPSR* DtTranslatablePartActuator::createPSR ( )

protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual double DtTranslatablePartActuator::currentPosition ( )

protectedvirtual

Returns: The current angle of the articulated part.

virtual void DtTranslatablePartActuator::setPositionAndRate	(	double	newPos,
		double	newRate
	)

protectedvirtual

Sets the new angle and rate of the articulated part.

virtual void DtTranslatablePartActuator::updatePartState ( )

protectedvirtual

Updates the information that will get updated for the part on the network as to the current translation state.

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

private

assignment operator; not implemented

Member Data Documentation

DtArticulatedPartStateRepository* DtTranslatablePartActuator::myArtPartStateRep

protected

The state repository that represents the Elevated articulated part

const DtTranslatablePartActuatorDescriptor* DtTranslatablePartActuator::myDescriptor

protected

The state repository that represents the Elevated articulated part

DtTranslatablePartActuatorPSR* DtTranslatablePartActuator::myProcessState

protected

The state repository that represents the Elevated articulated part

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/translatablePartActuator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation