DtFixedWingJoyDeviceControllerDescriptor, descriptor for the DtFixedWingJoyFlightController component. More...

Inheritance diagram for DtFixedWingJoyDeviceControllerDescriptor:

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

virtual int	pitchAxis () const
	Accessor/mutator for myPitchAxis.
virtual void	setPitchAxis (int axis)
	Accessor/mutator for myPitchAxis.

virtual bool	invertPitchAxis () const
	Accessor/mutator for myInvertPitchAxis.
virtual void	setInvertPitchAxis (bool invert)
	Accessor/mutator for myInvertPitchAxis.

virtual int	rollAxis () const
	Accessor/mutator for myRollAxis.
virtual void	setRollAxis (int axis)
	Accessor/mutator for myRollAxis.

virtual bool	invertRollAxis () const
	Accessor/mutator for myInvertRollAxis.
virtual void	setInvertRollAxis (bool invert)
	Accessor/mutator for myInvertRollAxis.

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

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

virtual int	pedalAxis () const
	Accessor/mutator for myPedalAxis.
virtual void	setPedalAxis (int axis)
	Accessor/mutator for myPedalAxis.

virtual bool	invertPedalAxis () const
	Accessor/mutator for myInvertPedalAxis.
virtual void	setInvertPedalAxis (bool invert)
	Accessor/mutator for myInvertPedalAxis.
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 DtFixedWingJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtFixedWingJoyDeviceControllerDescriptor ()
	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	myPitchAxis
	Parameter Name: joy-pitch-axis Parameter Description: Axis used for pitch.
DtRwBoolean	myInvertPitchAxis
	Parameter Name: joy-invert-pitch-axis Parameter Description: Inversion of the pitch axis.
DtRwInt	myRollAxis
	Parameter Name: joy-roll-axis Parameter Description: Axis used for roll.
DtRwBoolean	myInvertRollAxis
	Parameter Name: joy-invert-roll-axis Parameter Description: Inversion of the roll axis.
DtRwInt	myThrottleAxis
	Parameter Name: joy-throttle-axis Parameter Description: Axis used for throttle.
DtRwBoolean	myInvertThrottleAxis
	Parameter Name: joy-invert-throttle-axis Parameter Description: Inversion of the throttle axis.
DtRwInt	myPedalAxis
	Parameter Name: joy-pedal-axis Parameter Description: Axis used for pedal.
DtRwBoolean	myInvertPedalAxis
	Parameter Name: joy-invert-pedal-axis Parameter Description: Inversion of the pedal axis.
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	thePitchAxisName []
static const char	theInvertPitchAxisName []
static const char	theRollAxisName []
static const char	theInvertRollAxisName []
static const char	theThrottleAxisName []
static const char	theInvertThrottleAxisName []
static const char	thePedalAxisName []
static const char	theInvertPedalAxisName []
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

DtFixedWingJoyDeviceControllerDescriptor, descriptor for the DtFixedWingJoyFlightController component.

Instances of DtFixedWingJoyDeviceControllerDescriptor allow the remapping of the axes used for controlling a fixed wing entity with a joystick.

Constructor & Destructor Documentation

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

constructor

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

virtual DtFixedWingJoyDeviceControllerDescriptor::~DtFixedWingJoyDeviceControllerDescriptor ( )

virtual

destructor

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

copy constructor

DtFixedWingJoyDeviceControllerDescriptor::DtFixedWingJoyDeviceControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

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

assignment operator

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

virtual

Reimplemented from DtComponentDescriptor.

virtual DtString DtFixedWingJoyDeviceControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns: DtFixedWingJoyDeviceControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual int DtFixedWingJoyDeviceControllerDescriptor::pitchAxis ( ) const

virtual

Accessor/mutator for myPitchAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setPitchAxis ( int axis )

virtual

Accessor/mutator for myPitchAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertPitchAxis ( ) const

virtual

Accessor/mutator for myInvertPitchAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertPitchAxis ( bool invert )

virtual

Accessor/mutator for myInvertPitchAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::rollAxis ( ) const

virtual

Accessor/mutator for myRollAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setRollAxis ( int axis )

virtual

Accessor/mutator for myRollAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertRollAxis ( ) const

virtual

Accessor/mutator for myInvertRollAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertRollAxis ( bool invert )

virtual

Accessor/mutator for myInvertRollAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::throttleAxis ( ) const

virtual

Accessor/mutator for myThrottleAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setThrottleAxis ( int axis )

virtual

Accessor/mutator for myThrottleAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertThrottleAxis ( ) const

virtual

Accessor/mutator for myInvertThrottleAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertThrottleAxis ( bool invert )

virtual

Accessor/mutator for myInvertThrottleAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::pedalAxis ( ) const

virtual

Accessor/mutator for myPedalAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setPedalAxis ( int axis )

virtual

Accessor/mutator for myPedalAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertPedalAxis ( ) const

virtual

Accessor/mutator for myInvertPedalAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertPedalAxis ( bool invert )

virtual

Accessor/mutator for myInvertPedalAxis.

static DtComponentDescriptor* DtFixedWingJoyDeviceControllerDescriptor::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 DtFixedWingJoyDeviceControllerDescriptor::setDefaults ( )

protectedvirtual

set default values;

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

protectedvirtual

Copy over the parameters.

Member Data Documentation

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myPitchAxis

protected

Parameter Name: joy-pitch-axis
Parameter Description: Axis used for pitch.

Parameter Default Value: 1

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertPitchAxis

protected

Parameter Name: joy-invert-pitch-axis
Parameter Description: Inversion of the pitch axis.

Parameter Default Value: True

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myRollAxis

protected

Parameter Name: joy-roll-axis
Parameter Description: Axis used for roll.

Parameter Default Value: 0

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertRollAxis

protected

Parameter Name: joy-invert-roll-axis
Parameter Description: Inversion of the roll axis.

Parameter Default Value: False

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myThrottleAxis

protected

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

Parameter Default Value: 3

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertThrottleAxis

protected

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

Parameter Default Value: True

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myPedalAxis

protected

Parameter Name: joy-pedal-axis
Parameter Description: Axis used for pedal.

Parameter Default Value: 5

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertPedalAxis

protected

Parameter Name: joy-invert-pedal-axis
Parameter Description: Inversion of the pedal axis.

Parameter Default Value: False

const char DtFixedWingJoyDeviceControllerDescriptor::thePitchAxisName[]

staticprotected