DtUiMultiSystemElement Class Reference

Inheritance diagram for DtUiMultiSystemElement:

Public Member Functions
	DtUiMultiSystemElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiMultiSystemElement ()
	Destructor.
	DtUiMultiSystemElement (const DtUiMultiSystemElement &orig)
	Copy constructor.
DtUiMultiSystemElement &	operator= (const DtUiMultiSystemElement &orig)
	Assignment operator.
virtual void	chooseSystemToAdd ()
	Brings up the Add System dialog and starts the system adding process.
virtual void	addSystem (const DtSystemDefinitionInfo &sysDefInfo)
	Adds the system specified in the sysDefInfo to the entity parameters.
virtual void	removeSystem ()
	Removes the currently selected system from the entity.
virtual void	openPropertyEditWindow ()
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual void	onSelectionChanged ()
	Called each time the list selection changes.
Public Member Functions inherited from DtUiSystemElement
	DtUiSystemElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiSystemElement ()
	Destructor.
	DtUiSystemElement (const DtUiSystemElement &orig)
	Copy constructor.
DtUiSystemElement &	operator= (const DtUiSystemElement &orig)
	Assignment operator.
virtual void	init ()
virtual void	launchOpdEditor ()
virtual void	replaceSystem (DtMtlParameterDbEntry *entry, const DtComponentSystemDescriptor &system)
	If the system exists in the supplied parameter, replace it by first removing it then adding it back in.
virtual void	deleteSystem (DtMtlParameterDbEntry *entry, const DtFilename &system)
	If the system exists in the supplied parameter, remove it.
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 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	objectParametersModified ()
	This method is called any time that any of the parameters for the object are modified.
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 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 Types
typedef std::list < DtComponentSystemDescriptor * >	DtSystemDescriptorList

Protected Member Functions
virtual void	setFromParameters (DtReaderWriter *parentRw)
virtual DtReaderWriterRegistryData *	value (DtReaderWriter *parentRw)
	Seeds myValue and myBackupValue if not set.
virtual void	processUiEvent (const DtUiElementEvent &)
	Process ui event. Default does nothing.
virtual QWidget *	createLabelWidget (QWidget *parent)
	Create and return the label widget for this element.
virtual QWidget *	createControls (QWidget *)
	Creates and returns the non-label part of the element.
virtual void	createSystemSignalHandler ()
virtual void	elementChanged ()
virtual QString	uniqueDisplayName (const QString &baseName)
virtual DtSystemSelectionDialog *	createSystemSelectionDialog (QWidget *p)
virtual QString	getOpdEditorArguments () const
	Add system to select.
virtual void	dialogDone (bool)
virtual DtUiElement *	clone ()
Protected Member Functions inherited from DtUiSystemElement
virtual void	findAvailableSystems ()
	Fills in myAvailableSystems with the systems that match myCategory and the state repository type.
virtual DtComponentSystemDescriptor *	addSystemToParameters (const DtFilename &sysDefFilename, const DtString &name="")
	Adds the specified system to the parameters for the entity.
virtual void	removeSystemFromParameters (DtComponentSystemDescriptor *sysDescriptor, bool deleteDescriptor=true)
virtual void	removeSystemFromParameters (const DtComponentSystemDescriptor &sysDescriptor)
virtual DtString	availableSystemName (const DtString &baseName)
virtual void	addSoilTypesFromSystem (const DtComponentSystemDefinition *systemDef)
	Checks to see if there is a DtSoilFactorsMetaDataEntry in the system definition, and if so, copies the soil factors from this entry into the parameters for the entity.
virtual DtSystemPropertyEditDialog *	createSystemPropertyDialog (DtComponentSystemDescriptor *desc, const DtComponentSystemDefinition *definition, QWidget *parentWidget)
	Creates a new property edit dialog for a system and returns it.
virtual QList < DtComponentSystemDescriptor * >	systemsFor (const DtFilename &) const
virtual void	mergeBindings (const DtRwVariableBindings *source, DtRwVariableBindings *destination) const
	Merges the contents of the source into the destination bindings.
virtual void	loadSystem (DtMtlParameterDbEntry *entry, DtComponentSystemDescriptor *desc) const
Protected Member Functions inherited from DtUiElement
virtual QWidget *	createDataEntryElement (QWidget *)
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
DtSystemPropertyEditDialogShdPtr	myCurrentDialog
QListWidget *	myList
QAbstractButton *	myAddButton
QAbstractButton *	myRemoveButton
QAbstractButton *	myPropertiesButton
QAbstractButton *	myLaunchOpdEditor
DtSystemDescriptorList	mySystemDescriptors
	Keeps pointers to all the system descriptors in the parameter list that are managed by this UI Element.
QFrame *	myFrame
QLabel *	myLabel
Protected Attributes inherited from DtUiSystemElement
DtRwString	myCategory
DtSystemDefinitionInfoList	myAvailableSystems
DtUiSystemElementSignalHandler *	mySystemElementSignalHandler
DtRwBoolean *	myModified
DtVrfObjectParameters *	myObjectParameters
	Tracks whether this system selector has been modified.
bool	myPassEventsToDialog
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 DtUiSystemElement
static void	stopOpdEditor ()
	If opd editor has been launched, stop process here.
Static Protected Member Functions inherited from DtUiSystemElement
static const DtComponentSystemDefinition *	findSystemInfoForFilename (const DtFilename &filename, const DtSystemDefinitionInfoList &list)
Static Protected Attributes inherited from DtUiSystemElement
static QProcess *	theOpdEditorProcess

Member Typedef Documentation

typedef std::list<DtComponentSystemDescriptor*> DtUiMultiSystemElement::DtSystemDescriptorList

protected

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiMultiSystemElement::~DtUiMultiSystemElement ( )

virtual

Destructor.

DtUiMultiSystemElement::DtUiMultiSystemElement

(

const DtUiMultiSystemElement &

orig

)

Copy constructor.

Member Function Documentation

DtUiMultiSystemElement& DtUiMultiSystemElement::operator=

(

const DtUiMultiSystemElement &

orig

)

Assignment operator.

virtual void DtUiMultiSystemElement::chooseSystemToAdd ( )

virtual

Brings up the Add System dialog and starts the system adding process.

virtual void DtUiMultiSystemElement::addSystem ( const DtSystemDefinitionInfo &  sysDefInfo )

virtual

Adds the system specified in the sysDefInfo to the entity parameters.

virtual void DtUiMultiSystemElement::removeSystem ( )

virtual

Removes the currently selected system from the entity.

virtual void DtUiMultiSystemElement::openPropertyEditWindow ( )

virtual

Reimplemented from DtUiSystemElement.

virtual bool DtUiMultiSystemElement::isModified ( ) const

virtual

Reimplemented from DtUiSystemElement.

virtual void DtUiMultiSystemElement::decorateElement ( )

virtual

Sets element decoration depending on the isModified state of the element.

This version changes myLabel font.

Reimplemented from DtUiElement.

virtual void DtUiMultiSystemElement::onSelectionChanged ( )

virtual

Called each time the list selection changes.

virtual void DtUiMultiSystemElement::setFromParameters ( DtReaderWriter *  parentRw )

protectedvirtual

Reimplemented from DtUiSystemElement.

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

protectedvirtual

Seeds myValue and myBackupValue if not set.

Returns myValue based on myReaderWriterName

Reimplemented from DtUiSystemElement.

virtual void DtUiMultiSystemElement::processUiEvent ( const DtUiElementEvent &  )

protectedvirtual

Process ui event. Default does nothing.

Reimplemented from DtUiElement.

virtual QWidget* DtUiMultiSystemElement::createLabelWidget ( QWidget *  parent )

inlineprotectedvirtual

Create and return the label widget for this element.

May return NULL if not special label element is needed.

Reimplemented from DtUiElement.

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

protectedvirtual

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

Reimplemented from DtUiElement.

virtual void DtUiMultiSystemElement::createSystemSignalHandler ( )

protectedvirtual

Reimplemented from DtUiSystemElement.

virtual void DtUiMultiSystemElement::elementChanged ( )

protectedvirtual

Reimplemented from DtUiElement.

virtual QString DtUiMultiSystemElement::uniqueDisplayName ( const QString &  baseName )

protectedvirtual

Returns

A name based on baseName that is not already used in the list.

virtual DtSystemSelectionDialog* DtUiMultiSystemElement::createSystemSelectionDialog ( QWidget *  p )

protectedvirtual

virtual QString DtUiMultiSystemElement::getOpdEditorArguments ( ) const

protectedvirtual

Add system to select.

Reimplemented from DtUiSystemElement.

virtual void DtUiMultiSystemElement::dialogDone ( bool  )

protectedvirtual

Reimplemented from DtUiSystemElement.

virtual DtUiElement* DtUiMultiSystemElement::clone ( )

protectedvirtual

Reimplemented from DtUiSystemElement.

Member Data Documentation

DtSystemPropertyEditDialogShdPtr DtUiMultiSystemElement::myCurrentDialog

protected

QListWidget* DtUiMultiSystemElement::myList

protected

QAbstractButton* DtUiMultiSystemElement::myAddButton

protected

QAbstractButton* DtUiMultiSystemElement::myRemoveButton

protected

QAbstractButton* DtUiMultiSystemElement::myPropertiesButton

protected

QAbstractButton* DtUiMultiSystemElement::myLaunchOpdEditor

protected

DtSystemDescriptorList DtUiMultiSystemElement::mySystemDescriptors

protected

Keeps pointers to all the system descriptors in the parameter list that are managed by this UI Element.

QFrame* DtUiMultiSystemElement::myFrame

protected

QLabel* DtUiMultiSystemElement::myLabel

protected

---

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

• include/entityEditorImpl/uiMultiSystemElement.h