OmgAlgorithmParameter Class Reference
[Library]

#include <omgalgorithmparameter.h>

Inheritance diagram for OmgAlgorithmParameter:

[legend]Collaboration diagram for OmgAlgorithmParameter:

[legend]List of all members.

---

Detailed Description

An algorithm parameter is a representation of a single parameter associated with an algorithm. It is (de)serialisable to xml.

See also:

OmgAlgorithm

Definition at line 32 of file omgalgorithmparameter.h.

Public Member Functions
	OmgAlgorithmParameter ()
	~OmgAlgorithmParameter ()
	OmgAlgorithmParameter (QString theId, QString theName, QString theDefault, QString theOverview, QString theDescription, QString theMinimum, QString theMaximum, QString theValue)
QString	toXml () const
bool	fromXml (const QString theXml)
QString	toModelCreationXml () const
QString	toString () const
void	setId (QString theId)
void	setName (QString theName)
void	setType (QString theType)
void	setDefault (QString theDefault)
void	setOverview (QString theOverview)
void	setDescription (QString theDescription)
void	setMinimum (QString theMinimum)
void	setMaximum (QString theMaximum)
void	setValue (QString theValue)
QString	id () const
QString	name () const
QString	type () const
QString	overview () const
QString	defaultValue () const
QString	description () const
QString	minimum () const
QString	maximum () const
QString	value () const
Private Attributes
QString	mId
QString	mName
QString	mType
QString	mDefault
QString	mOverview
QString	mDescription
QString	mMinimum
QString	mMaximum
QString	mValue

---

Constructor & Destructor Documentation

OmgAlgorithmParameter::OmgAlgorithmParameter (   )

Definition at line 25 of file omgalgorithmparameter.cpp.

OmgAlgorithmParameter::~OmgAlgorithmParameter (   )

Definition at line 27 of file omgalgorithmparameter.cpp.

OmgAlgorithmParameter::OmgAlgorithmParameter (  QString  theId, QString  theName, QString  theDefault, QString  theOverview, QString  theDescription, QString  theMinimum, QString  theMaximum, QString  theValue )

Definition at line 29 of file omgalgorithmparameter.cpp.

---

Member Function Documentation

QString OmgAlgorithmParameter::defaultValue (   )  const

Definition at line 97 of file omgalgorithmparameter.cpp. References mDefault. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), toModelCreationXml(), and toXml().

QString OmgAlgorithmParameter::description (   )  const

Definition at line 105 of file omgalgorithmparameter.cpp. References mDescription. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and toXml().

bool OmgAlgorithmParameter::fromXml (  const QString  theXml  )  [virtual]

Implments the serialisable interface method to reinstate an algorithm. It will try to populate all members of this class and fail gracefully when they are not available (typically by leaving the member tagged as [Not Set] Implements OmgSerialisable. Definition at line 172 of file omgalgorithmparameter.cpp. References setDefault(), setDescription(), setId(), setMaximum(), setMinimum(), setName(), setOverview(), setType(), and setValue(). Referenced by OmgAlgorithm::fromXml().

Here is the call graph for this function:

QString OmgAlgorithmParameter::id (   )  const

Definition at line 85 of file omgalgorithmparameter.cpp. References mId. Referenced by OmgAlgorithmManager::on_pbnApply_clicked(), OmgAlgorithm::parameter(), OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and OmgAlgorithm::toString().

QString OmgAlgorithmParameter::maximum (   )  const

Definition at line 113 of file omgalgorithmparameter.cpp. References mMaximum. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and toXml().

QString OmgAlgorithmParameter::minimum (   )  const

Definition at line 109 of file omgalgorithmparameter.cpp. References mMinimum. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and toXml().

QString OmgAlgorithmParameter::name (   )  const

Definition at line 89 of file omgalgorithmparameter.cpp. References mName. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and toXml().

QString OmgAlgorithmParameter::overview (   )  const

Definition at line 101 of file omgalgorithmparameter.cpp. References mOverview. Referenced by toXml().

void OmgAlgorithmParameter::setDefault (  QString  theDefault  )

Definition at line 61 of file omgalgorithmparameter.cpp. References mDefault. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setDescription (  QString  theDescription  )

Definition at line 69 of file omgalgorithmparameter.cpp. References mDescription. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setId (  QString  theId  )

Definition at line 49 of file omgalgorithmparameter.cpp. References mId. Referenced by fromXml(), OmgModellerLocalPlugin::getAlgorithm(), and OmgAlgorithm::parameter().

void OmgAlgorithmParameter::setMaximum (  QString  theMaximum  )

Definition at line 77 of file omgalgorithmparameter.cpp. References mMaximum. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setMinimum (  QString  theMinimum  )

Definition at line 73 of file omgalgorithmparameter.cpp. References mMinimum. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setName (  QString  theName  )

Definition at line 53 of file omgalgorithmparameter.cpp. References mName. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setOverview (  QString  theOverview  )

Definition at line 65 of file omgalgorithmparameter.cpp. References mOverview. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setType (  QString  theType  )

Definition at line 57 of file omgalgorithmparameter.cpp. References mType. Referenced by fromXml(), and OmgModellerLocalPlugin::getAlgorithm().

void OmgAlgorithmParameter::setValue (  QString  theValue  )

The user defined value for this parameter Definition at line 81 of file omgalgorithmparameter.cpp. References mValue. Referenced by fromXml(), and OmgAlgorithmManager::on_pbnApply_clicked().

QString OmgAlgorithmParameter::toModelCreationXml (   )  const

This is a special case serialiser needed for when preparing an xml representation of a parameter to send to the openmodeller library (or openmodeller web service interface). The xml produced will include no ancilliary meta information - only the essentials needed for the algorithm. For example: <Parameter Value="0.674" Id="StandardDeviationCutoff" /> Returns: a string containing the parameter xml representation or if something went wrong and empty string. Definition at line 158 of file omgalgorithmparameter.cpp. References defaultValue(), and value(). Referenced by OmgAlgorithm::toModelCreationXml(), and OmgAlgorithm::toModelProjectionXml().

Here is the call graph for this function:

QString OmgAlgorithmParameter::toString (   )  const

Provide a string representation of this param Definition at line 121 of file omgalgorithmparameter.cpp. References mDefault, mDescription, mId, mMaximum, mMinimum, mName, mType, and mValue.

QString OmgAlgorithmParameter::toXml (   )  const [virtual]

This method is required for the serialiseable interface. It will encapsulate *all* algorithm parameters so that its complete state can be serialised and later deserialised. See also: toModelCreationXml() Note: no special case is provided for model projection as no parameters should normally be needed. Implements OmgSerialisable. Definition at line 134 of file omgalgorithmparameter.cpp. References defaultValue(), description(), maximum(), minimum(), name(), overview(), type(), and value(). Referenced by OmgAlgorithm::toXml().

Here is the call graph for this function:

QString OmgAlgorithmParameter::type (   )  const

Definition at line 93 of file omgalgorithmparameter.cpp. References mType. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), and toXml().

QString OmgAlgorithmParameter::value (   )  const

Definition at line 117 of file omgalgorithmparameter.cpp. References mValue. Referenced by OmgAlgorithmManager::setParametersGui(), OmgAlgorithm::toHtml(), toModelCreationXml(), OmgAlgorithm::toString(), and toXml().

---

Member Data Documentation

QString OmgAlgorithmParameter::mDefault [private]

Definition at line 109 of file omgalgorithmparameter.h. Referenced by defaultValue(), setDefault(), and toString().

QString OmgAlgorithmParameter::mDescription [private]

Definition at line 111 of file omgalgorithmparameter.h. Referenced by description(), setDescription(), and toString().

QString OmgAlgorithmParameter::mId [private]

Definition at line 106 of file omgalgorithmparameter.h. Referenced by id(), setId(), and toString().

QString OmgAlgorithmParameter::mMaximum [private]

Definition at line 113 of file omgalgorithmparameter.h. Referenced by maximum(), setMaximum(), and toString().

QString OmgAlgorithmParameter::mMinimum [private]

Definition at line 112 of file omgalgorithmparameter.h. Referenced by minimum(), setMinimum(), and toString().

QString OmgAlgorithmParameter::mName [private]

Definition at line 107 of file omgalgorithmparameter.h. Referenced by name(), setName(), and toString().

QString OmgAlgorithmParameter::mOverview [private]

Definition at line 110 of file omgalgorithmparameter.h. Referenced by overview(), and setOverview().

QString OmgAlgorithmParameter::mType [private]

Definition at line 108 of file omgalgorithmparameter.h. Referenced by setType(), toString(), and type().

QString OmgAlgorithmParameter::mValue [private]

Definition at line 114 of file omgalgorithmparameter.h. Referenced by setValue(), toString(), and value().

---

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

• lib/omgalgorithmparameter.h
• lib/omgalgorithmparameter.cpp

---