DtUiSystemElement Class Reference

Inheritance diagram for DtUiSystemElement:

Public Slots
virtual void	launchOpdEditor ()
Public Slots inherited from DtUiElement
virtual void	toggleDisplayed (bool display)

Public Member Functions
	DtUiSystemElement (makVrv::DtDe &)
	Constructor.
virtual	~DtUiSystemElement ()
	DTOR.
virtual void	replaceSystem (const DtFilename &system)
	If the system exists in the supplied parameter, replace it by first removing it then adding it back in.
virtual void	deleteSystem (const DtFilename &system)
	If the system exists in the supplied parameter, remove it.
virtual void	dialogDone (bool)
virtual void	openPropertyEditWindow ()
virtual std::vector< DtFilename >	possibleSystemFilenames (const DtFilename &filename) const
	Path search list of all possible matching directories for the given system filename.
Public Member Functions inherited from DtUiElement
	DtUiElement (makVrv::DtDe &)
	Constructor.
virtual	~DtUiElement ()
	Destructor.
virtual bool	blockSignals (bool)
virtual void	init (QWidget *widget, QWidget *label, DtReaderWriter *originalData, DtReaderWriter *backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const std::vector< DtReaderWriter * > &originalData, const std::vector< DtReaderWriter * > &backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const DtObjectType &, const DtString &platformType, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual void	setLabelText (const QString &)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual void	setFromSystemParameterData (const DtSystemParameterData *data, const DtComponentSystemDefinition *)
	Sets data of this UiElement from the specified system parameter data.
virtual void	objectParametersModified ()
	This method is called any time that any of the parameters for the object are modified.
virtual void	connectedTo (QObject *)
	Called when this item is connected to any signal emitted by the given item.
virtual void	processUiEvent (const DtUiElementEvent &)
	Process ui event. Default does nothing.
virtual void	setModelModified (DtModelSetEntry *)
	Called when the model is modified. Default is no-op.
virtual const DtString &	platformType () const
	Returns the type of platform this entity represents.
virtual void	setPlatformType (const DtString &)
	Sets the type of platform for this entity.
virtual void	setObjectTypes (const std::vector< DtObjectType > &)
	Sets the object type this element represents.
virtual void	aboutToShow ()
	Called when about to show as part of a properties dialog. Default is no-op.
const std::vector < DtReaderWriter * > &	values () const
const std::vector < DtReaderWriter * > &	backupValues () const
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual void	setFromParameters (DtReaderWriter *parentRw)
	Calls setFromParameters with std::vector of parameter.
virtual bool	restoreFromBackup ()
	Restores this element from a backup created with the specified name.
const std::vector< DtObjectType > &	objectTypes () const
virtual void	sendEvent (const DtUiElementEvent &)
virtual bool	allValuesTheSame () const
virtual bool	isMixedValue () const
	If widget is line edit and the value is mixedText returns true, else the subclass will need to return this value.
virtual void	setEnabled (bool)
	If this item is not enabled it cannot be modified.
virtual bool	enabled () const

Static Public Member Functions
static void	stopOpdEditor ()
Static Public Member Functions inherited from DtUiElement
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (makVrv::DtDe &, const DtString &type)
static bool	hasCreator (const DtString &)
static void	theNullFunction (DtUiElement *)
static UiElementFactoryMap &	elementFactory ()
static QString	mixedText ()
static void	setMixedText (const QString &)

Protected Member Functions
virtual void	setFromParameters (const std::vector< DtReaderWriter * > &parentRw)
virtual void	findAvailableSystems ()
	Fills in myAvailableSystems with the systems that match myCategory and the state repository type.
virtual DtRwVariableBindings *	addSystemToParameters (const DtFilename &sysDefFilename, DtReaderWriter *system)
	Adds the specified system to the parameters for the entity.
virtual void	removeSystemFromParameters (const DtRwVariableBindings *sysDescriptor, DtReaderWriter *system)
virtual DtString	availableSystemName (const DtString &baseName)
virtual DtSystemPropertyEditDialog *	createSystemPropertyDialog (const std::vector< DtRwVariableBindings * > &desc, const DtComponentSystemDefinition *definition, QWidget *parentWidget)
	Creates a new property edit dialog for a system and returns it.
virtual const DtComponentSystemDefinition *	findSystemInfoForFilename (const DtFilename &filename, const DtSystemDefinitionInfoList &list, bool &exists) const
virtual QList< const DtRwVariableBindings * >	systemsFor (const DtFilename &, DtRwVariableBindingsList *list) const
virtual void	mergeBindings (const DtRwVariableBindings *source, DtRwVariableBindings *destination) const
	Merges the contents of the source into the destination bindings.
virtual DtString	uniqueName () const
	Returns a unique name for this element.
virtual bool	supportsSystems () const
	Returns true if this element supports systes.
virtual void	createControls (QWidget *parent)
	If additional widgets or connections need to be made do it here. The parent is the myWidget member.
virtual QString	getOpdEditorArguments () const
Protected Member Functions inherited from DtUiElement
virtual double	sourceToDisplayUnits (double) const
virtual double	displayToSourceUnits (double) const
virtual QString	units () const
virtual void	updateLabelTitle ()
	Updates label title based on valid units.
virtual QString	labelTitle () const
	Returns the unmodified label title.

Protected Attributes
DtString	myCategory
DtSystemDefinitionInfoList	myAvailableSystems
bool	myPassEventsToDialog
Protected Attributes inherited from DtUiElement
DtString	myDisplayUnits
DtString	mySourceUnits
std::vector< DtReaderWriter * >	myValues
	Assumes 1 - 1 order that original and backup are same index in lists.
std::vector< DtReaderWriter * >	myBackupValues
bool	myIsNew
DtElementChangedCallbackFcn	myElementChangedCallbackFunction
DtUnit	mySource
DtUnit	myDestination
makVrv::DtDe &	myDe
DtString	myPlatformType
std::vector< DtObjectType >	myObjectTypes
const DtComponentSystemDefinition *	mySystemDefinition
bool	myEnabled
std::vector< QObject * >	myConnectedTo
int	myUniqueId

Static Protected Attributes
static QProcess *	theOpdEditorProcess
Static Protected Attributes inherited from DtUiElement
static UiElementFactoryMap	theFactory

Additional Inherited Members
Public Types inherited from DtUiElement
typedef boost::function < DtUiElement *(makVrv::DtDe &)>	CreatorFunction
typedef std::map< std::string, CreatorFunction >	UiElementFactoryMap
Signals inherited from DtUiElement
void	uiEvent (const DtUiElementEvent &)
Public Attributes inherited from DtUiElement
QWidget *	myWidget
QWidget *	myLabel
Protected Slots inherited from DtUiElement
virtual void	elementChanged ()
virtual void	enableIfChecked ()
	Connected to if the enable_if_checked property is set, and there is a matching check box for the enable_if_checked property.
virtual void	disableIfChecked ()
	Connected to if the disable_if_checked property is set, and there is a matching check box for the disable_if_checked property.

Constructor & Destructor Documentation

DtUiSystemElement::DtUiSystemElement

(

makVrv::DtDe &

)

Constructor.

virtual DtUiSystemElement::~DtUiSystemElement ( )

virtual

DTOR.

Member Function Documentation

virtual void DtUiSystemElement::replaceSystem ( const DtFilename &  system )

virtual

If the system exists in the supplied parameter, replace it by first removing it then adding it back in.

virtual void DtUiSystemElement::deleteSystem ( const DtFilename &  system )

virtual

If the system exists in the supplied parameter, remove it.

virtual void DtUiSystemElement::dialogDone ( bool  )

virtual

Reimplemented in DtUiMultiSystemElement.

virtual void DtUiSystemElement::openPropertyEditWindow ( )

virtual

Reimplemented in DtUiScriptedMovementSystemElement.

static void DtUiSystemElement::stopOpdEditor ( )

static

virtual std::vector<DtFilename> DtUiSystemElement::possibleSystemFilenames ( const DtFilename &  filename ) const

virtual

Path search list of all possible matching directories for the given system filename.

virtual void DtUiSystemElement::setFromParameters ( const std::vector< DtReaderWriter * > &  parentRw )

protectedvirtual

Reimplemented from DtUiElement.

Reimplemented in DtUiMultiSystemElement, DtUiSingleSystemElement, and DtUiScriptedMovementSystemElement.

virtual void DtUiSystemElement::findAvailableSystems ( )

protectedvirtual

Fills in myAvailableSystems with the systems that match myCategory and the state repository type.

Reimplemented in DtUiSingleSystemElement.

virtual DtRwVariableBindings* DtUiSystemElement::addSystemToParameters ( const DtFilename &  sysDefFilename, DtReaderWriter *  system  )

protectedvirtual

Adds the specified system to the parameters for the entity.

Returns

The pointer to the system descriptor entry in the system list.

virtual void DtUiSystemElement::removeSystemFromParameters ( const DtRwVariableBindings *  sysDescriptor, DtReaderWriter *  system  )

protectedvirtual

virtual DtString DtUiSystemElement::availableSystemName ( const DtString &  baseName )

protectedvirtual

Returns

A valid (not already used) name within the system list that is based off the specified baseName.

virtual DtSystemPropertyEditDialog* DtUiSystemElement::createSystemPropertyDialog ( const std::vector< DtRwVariableBindings * > &  desc, const DtComponentSystemDefinition *  definition, QWidget *  parentWidget  )

protectedvirtual

Creates a new property edit dialog for a system and returns it.

The dialog is not shown by this method, just created.

virtual const DtComponentSystemDefinition* DtUiSystemElement::findSystemInfoForFilename ( const DtFilename &  filename, const DtSystemDefinitionInfoList &  list, bool &  exists  ) const

protectedvirtual

Returns

The DtSystemDefinitionInfo from the specified list which as the matching filename to the specified filename.

virtual QList<const DtRwVariableBindings*> DtUiSystemElement::systemsFor ( const DtFilename &  , DtRwVariableBindingsList *  list  ) const

protectedvirtual

Returns

The systems in the parameter entry that exactly match the given filename

virtual void DtUiSystemElement::mergeBindings ( const DtRwVariableBindings *  source, DtRwVariableBindings *  destination  ) const

protectedvirtual

Merges the contents of the source into the destination bindings.

It will reassign values from the source into the destination, if the value exists in the destination

virtual DtString DtUiSystemElement::uniqueName ( ) const

protectedvirtual

Returns a unique name for this element.

If there is a myValue returns the name of that value, else returns "DtUiElement"

Reimplemented from DtUiElement.

virtual bool DtUiSystemElement::supportsSystems ( ) const

protectedvirtual

Returns true if this element supports systes.

Reimplemented from DtUiElement.

virtual void DtUiSystemElement::createControls ( QWidget *  parent )

protectedvirtual

If additional widgets or connections need to be made do it here. The parent is the myWidget member.

Reimplemented from DtUiElement.

Reimplemented in DtUiMultiSystemElement, DtUiSingleSystemElement, and DtUiScriptedMovementSystemElement.

virtual QString DtUiSystemElement::getOpdEditorArguments ( ) const

protectedvirtual

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual void DtUiSystemElement::launchOpdEditor ( )

virtualslot

Member Data Documentation

DtString DtUiSystemElement::myCategory

protected

DtSystemDefinitionInfoList DtUiSystemElement::myAvailableSystems

protected

bool DtUiSystemElement::myPassEventsToDialog

protected

QProcess* DtUiSystemElement::theOpdEditorProcess

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/simulationObjectEditorImpl/uiSystemElement.h