DtGroundJoyDeviceControllerDescriptor. More...

Inheritance diagram for DtGroundJoyDeviceControllerDescriptor:

Public Member Functions
	DtGroundJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtGroundJoyDeviceControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtGroundJoyDeviceControllerDescriptor ()
	destructor
	DtGroundJoyDeviceControllerDescriptor (const DtGroundJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtGroundJoyDeviceControllerDescriptor &	operator= (const DtGroundJoyDeviceControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of descriptor.

virtual void	setSteeringAxis (int axis)
	Accessor/mutator for mySteeringAxis.
virtual int	steeringAxis () const
	Accessor/mutator for mySteeringAxis.

virtual void	setInvertSteeringAxis (bool invert)
	Accessor/mutator for myInvertSteeringAxis.
virtual bool	invertSteeringAxis () const
	Accessor/mutator for myInvertSteeringAxis.

virtual void	setThrottleAxis (int axis)
	Accessor/mutator for myThrottleAxis.
virtual int	throttleAxis () const
	Accessor/mutator for myThrottleAxis.

virtual void	setInvertThrottleAxis (bool invert)
	Accessor/mutator for myInvertThrottleAxis.
virtual bool	invertThrottleAxis () const
	Accessor/mutator for myInvertThrottleAxis.

virtual void	setBrakeButton (int button)
	Accessor/mutator for myBrakeButton.
virtual int	brakeButton () const
	Accessor/mutator for myBrakeButton.

virtual void	setForwardGearButton (int button)
	Accessor/mutator for myForwardGearButton.
virtual int	forwardGearButton () const
	Accessor/mutator for myForwardGearButton.

virtual void	setReverseGearButton (int button)
	Accessor/mutator for myReverseGearButton.
virtual int	reverseGearButton () const
	Accessor/mutator for myReverseGearButton.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
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 actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
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
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 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 DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
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.

Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtGroundJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtGroundJoyDeviceControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
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.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	mySteeringAxis
	Parameter Name: joy-steering-axis Parameter Description: Axis used for steering Parameter Default Value: 5 .
DtRwBoolean	myInvertSteeringAxis
	Parameter Name: joy-invert-steering-axis Parameter Description: Inversion of the steering axis Parameter Default Value: False .
DtRwInt	myThrottleAxis
	Parameter Name: joy-throttle-axis Parameter Description: Axis used for throttle Parameter Default Value: 3 .
DtRwBoolean	myInvertThrottleAxis
	Parameter Name: joy-invert-throttle-axis Parameter Description: Inversion of the throttle axis Parameter Default Value: True .
DtRwInt	myBrakeButton
	Parameter Name: joy-brake-button Parameter Description: Button used for braking Parameter Default Value: 3 .
DtRwInt	myForwardGearButton
	Parameter Name: joy-forward-gear-button Parameter Description: Button used to select forward gear Parameter Default Value: 4 .
DtRwInt	myReverseGearButton
	Parameter Name: joy-reverse-gear-button Parameter Description: Button used to select reverse gear Parameter Default Value: 5 .
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
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.

Static Protected Attributes
static const char	theSteeringAxisName []
	Constants for reader-writer names.
static const char	theInvertSteeringAxisName []
static const char	theThrottleAxisName []
static const char	theInvertThrottleAxisName []
static const char	theBrakeButtonName []
static const char	theForwardGearButtonName []
static const char	theReverseGearButtonName []
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

Detailed Description

DtGroundJoyDeviceControllerDescriptor.

class DtGroundJoyDeviceControllerDescriptor:

Instances of DtGroundJoyDeviceControllerDescriptor allow the remapping of the axes used for steering and throttle, as well as the buttons used for braking and gear changes.

Constructor & Destructor Documentation

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

constructor

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

virtual DtGroundJoyDeviceControllerDescriptor::~DtGroundJoyDeviceControllerDescriptor ( )

virtual

destructor

DtGroundJoyDeviceControllerDescriptor::DtGroundJoyDeviceControllerDescriptor	(	const DtGroundJoyDeviceControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

DtGroundJoyDeviceControllerDescriptor::DtGroundJoyDeviceControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

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

assignment operator

virtual DtComponentDescriptor* DtGroundJoyDeviceControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

virtual

Reimplemented from DtComponentDescriptor.

virtual DtString DtGroundJoyDeviceControllerDescriptor::type ( ) const

virtual

Returns the type of descriptor.

This will be used to create the descriptor read from an mtl file.

Reimplemented from DtComponentDescriptor.

virtual void DtGroundJoyDeviceControllerDescriptor::setSteeringAxis ( int axis )

virtual

Accessor/mutator for mySteeringAxis.

virtual int DtGroundJoyDeviceControllerDescriptor::steeringAxis ( ) const

virtual

Accessor/mutator for mySteeringAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setInvertSteeringAxis ( bool invert )

virtual

Accessor/mutator for myInvertSteeringAxis.

virtual bool DtGroundJoyDeviceControllerDescriptor::invertSteeringAxis ( ) const

virtual

Accessor/mutator for myInvertSteeringAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setThrottleAxis ( int axis )

virtual

Accessor/mutator for myThrottleAxis.

virtual int DtGroundJoyDeviceControllerDescriptor::throttleAxis ( ) const

virtual

Accessor/mutator for myThrottleAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setInvertThrottleAxis ( bool invert )

virtual

Accessor/mutator for myInvertThrottleAxis.

virtual bool DtGroundJoyDeviceControllerDescriptor::invertThrottleAxis ( ) const

virtual

Accessor/mutator for myInvertThrottleAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setBrakeButton ( int button )

virtual

Accessor/mutator for myBrakeButton.

virtual int DtGroundJoyDeviceControllerDescriptor::brakeButton ( ) const

virtual

Accessor/mutator for myBrakeButton.

virtual void DtGroundJoyDeviceControllerDescriptor::setForwardGearButton ( int button )

virtual

Accessor/mutator for myForwardGearButton.

virtual int DtGroundJoyDeviceControllerDescriptor::forwardGearButton ( ) const

virtual

Accessor/mutator for myForwardGearButton.

virtual void DtGroundJoyDeviceControllerDescriptor::setReverseGearButton ( int button )

virtual

Accessor/mutator for myReverseGearButton.

virtual int DtGroundJoyDeviceControllerDescriptor::reverseGearButton ( ) const

virtual

Accessor/mutator for myReverseGearButton.

static DtComponentDescriptor* DtGroundJoyDeviceControllerDescriptor::creator ( )

static

Returns: Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

virtual void DtGroundJoyDeviceControllerDescriptor::setDefaults ( )

protectedvirtual

set default values;

virtual void DtGroundJoyDeviceControllerDescriptor::copyValues ( const DtGroundJoyDeviceControllerDescriptor & orig )

protectedvirtual

Copy over the parameters.

Member Data Documentation

DtRwInt DtGroundJoyDeviceControllerDescriptor::mySteeringAxis

protected

Parameter Name: joy-steering-axis
Parameter Description: Axis used for steering
Parameter Default Value: 5
.

DtRwBoolean DtGroundJoyDeviceControllerDescriptor::myInvertSteeringAxis

protected

Parameter Name: joy-invert-steering-axis
Parameter Description: Inversion of the steering axis
Parameter Default Value: False
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myThrottleAxis

protected

Parameter Name: joy-throttle-axis
Parameter Description: Axis used for throttle
Parameter Default Value: 3
.

DtRwBoolean DtGroundJoyDeviceControllerDescriptor::myInvertThrottleAxis

protected

Parameter Name: joy-invert-throttle-axis
Parameter Description: Inversion of the throttle axis
Parameter Default Value: True
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myBrakeButton

protected

Parameter Name: joy-brake-button
Parameter Description: Button used for braking
Parameter Default Value: 3
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myForwardGearButton

protected

Parameter Name: joy-forward-gear-button
Parameter Description: Button used to select forward gear
Parameter Default Value: 4
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myReverseGearButton

protected

Parameter Name: joy-reverse-gear-button
Parameter Description: Button used to select reverse gear
Parameter Default Value: 5
.

const char DtGroundJoyDeviceControllerDescriptor::theSteeringAxisName[]

staticprotected

Constants for reader-writer names.

const char DtGroundJoyDeviceControllerDescriptor::theInvertSteeringAxisName[]

staticprotected

const char DtGroundJoyDeviceControllerDescriptor::theThrottleAxisName[]

staticprotected

const char DtGroundJoyDeviceControllerDescriptor::theInvertThrottleAxisName[]

staticprotected

const char DtGroundJoyDeviceControllerDescriptor::theBrakeButtonName[]

staticprotected

const char DtGroundJoyDeviceControllerDescriptor::theForwardGearButtonName[]

staticprotected

const char DtGroundJoyDeviceControllerDescriptor::theReverseGearButtonName[]

staticprotected

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

include/vrfobjparam/gndJoystickDesc.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation