DtUiSystemElement Class Reference

Inheritance diagram for DtUiSystemElement:

List of all members.

Public Member Functions
	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	openPropertyEditWindow ()
virtual void	launchOpdEditor ()
virtual QString	getOpdEditorArguments () const
	Returns arguments that will be used to open the opd editor.
virtual bool	isModified () const
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.
virtual void	dialogDone (bool)
Static Public Member Functions
static void	stopOpdEditor ()
	If opd editor has been launched, stop process here.
Protected Member Functions
virtual DtUiElement *	clone ()
virtual void	setFromParameters (DtReaderWriter *parentRw)
virtual DtReaderWriterRegistryData *	value (DtReaderWriter *parentRw)
	Seeds myValue and myBackupValue if not set.
virtual void	findAvailableSystems ()
	Fills in myAvailableSystems with the systems that match myCategory and the state repository type.
virtual void	createSystemSignalHandler ()
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
Static Protected Member Functions
static const DtComponentSystemDefinition *	findSystemInfoForFilename (const DtFilename &filename, const DtSystemDefinitionInfoList &list)
Protected Attributes
DtRwString	myCategory
DtSystemDefinitionInfoList	myAvailableSystems
DtUiSystemElementSignalHandler *	mySystemElementSignalHandler
DtRwBoolean *	myModified
DtVrfObjectParameters *	myObjectParameters
	Tracks whether this system selector has been modified.
bool	myPassEventsToDialog
Static Protected Attributes
static QProcess *	theOpdEditorProcess

---

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiSystemElement::~DtUiSystemElement

(

)

[virtual]

Destructor.

DtUiSystemElement::DtUiSystemElement

(

const DtUiSystemElement &

orig

)

Copy constructor.

---

Member Function Documentation

DtUiSystemElement& DtUiSystemElement::operator=

(

const DtUiSystemElement &

orig

)

Assignment operator.

virtual void DtUiSystemElement::init

(

)

[virtual]

Reimplemented from DtUiElement.

virtual void DtUiSystemElement::openPropertyEditWindow

(

)

[virtual]

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual void DtUiSystemElement::launchOpdEditor

(

)

[virtual]

virtual QString DtUiSystemElement::getOpdEditorArguments

(

)

const [virtual]

Returns arguments that will be used to open the opd editor.

Default only sends current simulation model set file. Override to add arguments to that list

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual bool DtUiSystemElement::isModified

(

)

const [virtual]

Reimplemented from DtUiElement.

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

static void DtUiSystemElement::stopOpdEditor

(

)

[static]

If opd editor has been launched, stop process here.

virtual void DtUiSystemElement::replaceSystem	(	DtMtlParameterDbEntry *	entry,
		const DtComponentSystemDescriptor &	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	(	DtMtlParameterDbEntry *	entry,
		const DtFilename &	system
	)		[virtual]

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

virtual void DtUiSystemElement::dialogDone

(

bool

)

[virtual]

Reimplemented in DtUiMultiSystemElement.

virtual DtUiElement* DtUiSystemElement::clone

(

)

[protected, virtual]

Implements DtUiElement.

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual void DtUiSystemElement::setFromParameters

(

DtReaderWriter *

parentRw

)

[protected, virtual]

Reimplemented from DtUiElement.

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual DtReaderWriterRegistryData* DtUiSystemElement::value

(

DtReaderWriter *

parentRw

)

[protected, virtual]

Seeds myValue and myBackupValue if not set.

Returns myValue based on myReaderWriterName

Reimplemented from DtUiElement.

Reimplemented in DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual void DtUiSystemElement::findAvailableSystems

(

)

[protected, virtual]

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

Reimplemented in DtUiSingleSystemElement.

virtual void DtUiSystemElement::createSystemSignalHandler

(

)

[protected, virtual]

Reimplemented in DtUiMultiSystemElement.

virtual DtComponentSystemDescriptor* DtUiSystemElement::addSystemToParameters	(	const DtFilename &	sysDefFilename,
		const DtString &	name = ""
	)		[protected, virtual]

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	(	DtComponentSystemDescriptor *	sysDescriptor,
		bool	deleteDescriptor = true
	)		[protected, virtual]

virtual void DtUiSystemElement::removeSystemFromParameters

(

const DtComponentSystemDescriptor &

sysDescriptor

)

[protected, virtual]

virtual DtString DtUiSystemElement::availableSystemName

(

const DtString &

baseName

)

[protected, virtual]

Returns:

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

virtual void DtUiSystemElement::addSoilTypesFromSystem

(

const DtComponentSystemDefinition *

systemDef

)

[protected, virtual]

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.

If there is no such entry, nothing is done.

virtual DtSystemPropertyEditDialog* DtUiSystemElement::createSystemPropertyDialog	(	DtComponentSystemDescriptor *	desc,
		const DtComponentSystemDefinition *	definition,
		QWidget *	parentWidget
	)		[protected, virtual]

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

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

static const DtComponentSystemDefinition* DtUiSystemElement::findSystemInfoForFilename	(	const DtFilename &	filename,
		const DtSystemDefinitionInfoList &	list
	)		[static, protected]

Returns:

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

virtual QList<DtComponentSystemDescriptor*> DtUiSystemElement::systemsFor

(

const DtFilename &

)

const [protected, virtual]

Returns:

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

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

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 void DtUiSystemElement::loadSystem	(	DtMtlParameterDbEntry *	entry,
		DtComponentSystemDescriptor *	desc
	)		const [protected, virtual]

---

Member Data Documentation

DtRwString DtUiSystemElement::myCategory [protected]

DtSystemDefinitionInfoList DtUiSystemElement::myAvailableSystems [protected]

DtUiSystemElementSignalHandler* DtUiSystemElement::mySystemElementSignalHandler [protected]

DtRwBoolean* DtUiSystemElement::myModified [protected]

DtVrfObjectParameters* DtUiSystemElement::myObjectParameters [protected]

Tracks whether this system selector has been modified.

QProcess* DtUiSystemElement::theOpdEditorProcess [static, protected]

bool DtUiSystemElement::myPassEventsToDialog [protected]

---

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

• include/entityEditorImpl/uiSystemElement.h