DtUiAutoConnectionElement Class Reference

UI Element which automatically creates connections between specified systems. More...

Inheritance diagram for DtUiAutoConnectionElement:

Public Member Functions
	DtUiAutoConnectionElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiAutoConnectionElement ()
	Destructor.
	DtUiAutoConnectionElement (const DtUiAutoConnectionElement &orig)
	Copy constructor.
DtUiAutoConnectionElement &	operator= (const DtUiAutoConnectionElement &orig)
	Assignment operator.
virtual void	objectParametersModified ()
	Calls updatesensorConnections() and updateSensorConnections().
virtual QWidget *	createControls (QWidget *parent)
	Creates and returns the non-label part of the element.
Public Member Functions inherited from DtUiElement
	DtUiElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiElement ()
	Destructor.
	DtUiElement (const DtUiElement &orig)
	Copy constructor.
DtUiElement &	operator= (const DtUiElement &orig)
	Assignment operator.
virtual const DtString &	objectName () const
virtual void	setTitle (const DtString &s)
virtual void	setObjectName (const DtString &s)
virtual void	mergeInto (DtUiForParameter *)
virtual DtUiElement *	elementNamed (const DtString &)
virtual bool	mergeInto (const DtString &readerWriterName, bool after, DtUiElement *element)
virtual void	init ()
virtual DtString	sourceReaderWriterName () const
virtual void	setSourceReaderWriterName (const DtString &name)
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual DtString	tooltip () const
virtual void	setTooltip (const DtString &text)
virtual void	setFromSystemParameterData (const DtSystemParameterData *data)
	Sets data of this UiElement from the specified system parameter data.
virtual void	processUiEvent (const DtUiElementEvent &)
	Process ui event. Default does nothing.
DtReaderWriterRegistryData *	value () const
DtReaderWriterRegistryData *	backupValue () const
virtual void	initForControls ()
	Initializes element before creating controls. Sets parameter values to NULL.
virtual void	setModelModified (DtModelSetEntry *)
	Called when the model is modified. Default is no-op.
DtUiElementSignalHandler *	signalHandler ()
virtual void	uiState (QMap< QString, QVariant > &state) const
	State is a dictionary of a string that uniquely identifies a control and its state.
virtual void	setUiState (const QMap< QString, QVariant > &)
virtual void	sendUpdatedUiState ()
	Sends out updated ui state with message.
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual QWidget *	createLabelWidget (QWidget *parent)
	Create and return the label widget for this element.
virtual void	elementChanged ()
virtual void	addElementChangedCallback (DtElementChangedCallbackFcn f, void *usr)
virtual void	removeElementChangedCallback (DtElementChangedCallbackFcn f, void *usr)
virtual void	removeAllCallbacks ()
virtual DtReaderWriterRegistryData *	createBackup (const DtString &backupName)
	Creates a backup entry in the RW structure for the current value of this element.
virtual bool	restoreFromBackup (const DtString &backupName, bool deleteBackup=false)
	Restores this element from a backup created with the specified name.
virtual void	deleteBackup (const DtString &backupName)
	Deletes backup entries previously created with createBackup, with the specified name.
const DtCallbackList < DtUiElement * > &	elementChangedCallbackList () const
void	setElementChangedCallbackList (const DtCallbackList< DtUiElement * > &)
virtual DtReaderWriterRegistryData *	value (DtReaderWriter *parentRw, const DtString &rw, DtReaderWriterRegistryData **backupValue) const
virtual bool	centerElement () const
	Returns whether or not to center the element on the display.
virtual void	finalizeSize (QWidget *)
	Adjusts size of child by looking at min/max size. If any values are non-zero, sets to that value.
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.

Protected Member Functions
virtual const DtComponentSystemDefinition *	lookupSystemDefinition (const DtComponentSystemDescriptor *descriptor) const
virtual QWidget *	createDataEntryElement (QWidget *)
virtual bool	updateConnections ()
	Checks and updates connections between any applicable systems on the entity.
virtual std::list< DtSymbolString >	sourceSystems () const
virtual std::list< DtSymbolString >	destinationSystems () const
virtual bool	checkExistingConnection (const DtSymbolString &sourceName, const DtSymbolString &destinationName) const
	Checks for an existing connection between the two specified systems.
virtual void	addConnection (const DtSymbolString &sourceName, const DtSymbolString &destinationName) const
	Adds a new connection from the source to the destination.
virtual bool	removeDanglingConnections ()
	Goes though the connections list and removes any connections that don't have a source and/or destination, and that meet the name requirements for this UI element.
virtual bool	systemOrComponentExists (const DtString &name)
virtual void	updateDisplayLabel ()
	Updates the label displayed on the GUI with the current info about the controller.
virtual DtUiElement *	clone ()
virtual void	setFromParameters (DtReaderWriter *parentRw)
virtual DtReaderWriterRegistryData *	value (DtReaderWriter *parentRw)
	Seeds myValue and myBackupValue if not set.
Protected Member Functions inherited from DtUiElement
virtual double	sourceToDestination (double) const
virtual double	destinationToSource (double) const
virtual QString	units () const
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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwString	mySourceCategory
DtRwString	mySourcePortName
DtRwString	myDestinationCategory
DtRwString	myDestinationPortName
QLabel *	myInfoLabel
DtConnectionDescriptorList *	myConnectionList
DtVrfObjectParameters *	myObjectParameters
Protected Attributes inherited from DtUiElement
DtRwString	myReaderWriterName
DtRwString	myTitle
DtRwString	myDisplayUnits
DtRwString	mySourceUnits
DtRwString	myObjectName
DtRwString	myTooltip
DtRwBoolean	myCenterElement
DtRwInt	myMaximumWidth
DtRwInt	myMaximumHeight
DtRwInt	myMinimumWidth
DtRwInt	myMinimumHeight
DtReaderWriterRegistryData *	myValue
DtReaderWriterRegistryData *	myBackupValue
DtUiElementSignalHandler	mySignalHandler
DtRwBoolean	mySetVisible
bool	myIsNew
QWidget *	myLabel
DtCallbackList< DtUiElement * >	myElementChangedCallbackList
DtUnit	mySource
DtUnit	myDestination
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.

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
Static Public Member Functions inherited from DtUiElement
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (const DtString &type, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
static DtReaderWriterFactory *	elementFactory ()
Static Protected Attributes inherited from DtUiElement
static DtReaderWriterFactory	theFactory
static DtUnitConverterFactory	theConversionFactory

Detailed Description

UI Element which automatically creates connections between specified systems.

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiAutoConnectionElement::~DtUiAutoConnectionElement ( )

virtual

Destructor.

DtUiAutoConnectionElement::DtUiAutoConnectionElement

(

const DtUiAutoConnectionElement &

orig

)

Copy constructor.

Member Function Documentation

DtUiAutoConnectionElement& DtUiAutoConnectionElement::operator=

(

const DtUiAutoConnectionElement &

orig

)

Assignment operator.

virtual void DtUiAutoConnectionElement::objectParametersModified ( )

virtual

Calls updatesensorConnections() and updateSensorConnections().

Reimplemented from DtUiElement.

virtual QWidget* DtUiAutoConnectionElement::createControls ( QWidget *  parent )

virtual

Creates and returns the non-label part of the element.

Reimplemented from DtUiElement.

virtual const DtComponentSystemDefinition* DtUiAutoConnectionElement::lookupSystemDefinition ( const DtComponentSystemDescriptor *  descriptor ) const

protectedvirtual

virtual QWidget* DtUiAutoConnectionElement::createDataEntryElement ( QWidget *  )

protectedvirtual

Reimplemented from DtUiElement.

virtual bool DtUiAutoConnectionElement::updateConnections ( )

protectedvirtual

Checks and updates connections between any applicable systems on the entity.

Returns

True if any changes are made.

virtual std::list<DtSymbolString> DtUiAutoConnectionElement::sourceSystems ( ) const

protectedvirtual

Returns

A list of the system names that are connection sources for this UI element. All these systems will be the correct sourceCategory and have an output of the appropriate name.

virtual std::list<DtSymbolString> DtUiAutoConnectionElement::destinationSystems ( ) const

protectedvirtual

Returns

A list of the system names that are connection destinations for this UI element. All these systems will be the correct destinationCategory and have an input of the appropriate name.

virtual bool DtUiAutoConnectionElement::checkExistingConnection ( const DtSymbolString &  sourceName, const DtSymbolString &  destinationName  ) const

protectedvirtual

Checks for an existing connection between the two specified systems.

Uses the port names specified in this UI element.

virtual void DtUiAutoConnectionElement::addConnection ( const DtSymbolString &  sourceName, const DtSymbolString &  destinationName  ) const

protectedvirtual

Adds a new connection from the source to the destination.

virtual bool DtUiAutoConnectionElement::removeDanglingConnections ( )

protectedvirtual

Goes though the connections list and removes any connections that don't have a source and/or destination, and that meet the name requirements for this UI element.

It does not remove dangling connections that have names that don't match the source/destination name for this element.

Returns

True if any changes are made.

virtual bool DtUiAutoConnectionElement::systemOrComponentExists ( const DtString &  name )

protectedvirtual

Returns

True if a system, actuator, controller, or sensor with the specified name was found.

virtual void DtUiAutoConnectionElement::updateDisplayLabel ( )

protectedvirtual

Updates the label displayed on the GUI with the current info about the controller.

Should be called after every change to the controller.

virtual DtUiElement* DtUiAutoConnectionElement::clone ( )

protectedvirtual

Implements DtUiElement.

virtual void DtUiAutoConnectionElement::setFromParameters ( DtReaderWriter *  parentRw )

protectedvirtual

Reimplemented from DtUiElement.

virtual DtReaderWriterRegistryData* DtUiAutoConnectionElement::value ( DtReaderWriter *  parentRw )

protectedvirtual

Seeds myValue and myBackupValue if not set.

Returns myValue based on myReaderWriterName

Reimplemented from DtUiElement.

Member Data Documentation

DtRwString DtUiAutoConnectionElement::mySourceCategory

protected

DtRwString DtUiAutoConnectionElement::mySourcePortName

protected

DtRwString DtUiAutoConnectionElement::myDestinationCategory

protected

DtRwString DtUiAutoConnectionElement::myDestinationPortName

protected

QLabel* DtUiAutoConnectionElement::myInfoLabel

protected

DtConnectionDescriptorList* DtUiAutoConnectionElement::myConnectionList

protected

DtVrfObjectParameters* DtUiAutoConnectionElement::myObjectParameters

protected

---

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

• include/entityEditorImpl/uiAutoConnectionElement.h