DtUiAutoConnectionElement Class Reference

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

Inheritance diagram for DtUiAutoConnectionElement:

List of all members.

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.
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 Attributes
DtRwString	mySourceCategory
DtRwString	mySourcePortName
DtRwString	myDestinationCategory
DtRwString	myDestinationPortName
QLabel *	myInfoLabel
DtConnectionDescriptorList *	myConnectionList
DtVrfObjectParameters *	myObjectParameters

---

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 [protected, virtual]

virtual QWidget* DtUiAutoConnectionElement::createDataEntryElement

(

QWidget *

)

[protected, virtual]

Reimplemented from DtUiElement.

virtual bool DtUiAutoConnectionElement::updateConnections

(

)

[protected, virtual]

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 [protected, virtual]

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 [protected, virtual]

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 [protected, virtual]

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 [protected, virtual]

Adds a new connection from the source to the destination.

virtual bool DtUiAutoConnectionElement::removeDanglingConnections

(

)

[protected, virtual]

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

)

[protected, virtual]

Returns:

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

virtual void DtUiAutoConnectionElement::updateDisplayLabel

(

)

[protected, virtual]

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

(

)

[protected, virtual]

Implements DtUiElement.

virtual void DtUiAutoConnectionElement::setFromParameters

(

DtReaderWriter *

parentRw

)

[protected, virtual]

Reimplemented from DtUiElement.

virtual DtReaderWriterRegistryData* DtUiAutoConnectionElement::value

(

DtReaderWriter *

parentRw

)

[protected, virtual]

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