hds::BatchModuleParameter Class Reference

#include <hds_batch_module_parameter.hpp>

Inheritance diagram for hds::BatchModuleParameter:

Public Types
enum	Type {   Undefined = 0, Boolean, Integer, Double,   String, StringList, Enum, File,   LDB_Seismic }

Public Member Functions
	BatchModuleParameter ()
	BatchModuleParameter (const QVariant &value, const QString &comment)
virtual BatchModuleParameter *	clone () const
virtual	~BatchModuleParameter ()
virtual const QVariant &	value () const
virtual void	setValue (const QVariant &value)
virtual Type	type () const
const QString &	comment () const
void	setComment (const QString &comment)
virtual void	info () const

Static Public Member Functions
static QString	nameFromType (Type type)
static Type	typeFromName (const QString &name)

Protected Attributes
QVariant	m_value
QString	m_comment

Detailed Description

Standard parameter of the module.

Member Enumeration Documentation

enum hds::BatchModuleParameter::Type

Type of the parameter.

Enumerator
Undefined	Undefined parameter type.
Boolean	bool.
Integer	int.
Double	double.
String	QString.
StringList	QStringList.
Enum	Enumeration.
File	File parameter (name of the file as QString)
LDB_Seismic	UNIVERS ldb seismic file (as string).

Constructor & Destructor Documentation

hds::BatchModuleParameter::BatchModuleParameter

(

)

Constructs parameter with undefined type.

hds::BatchModuleParameter::BatchModuleParameter	(	const QVariant &	value,
		const QString &	comment
	)

Constructor with provided value and comment.

virtual hds::BatchModuleParameter::~BatchModuleParameter ( )

virtual

Destructor.

Member Function Documentation

virtual BatchModuleParameter* hds::BatchModuleParameter::clone ( ) const

virtual

Make copy of the object.

Reimplemented in hds::BatchModuleLDBSeisParameter, hds::BatchModuleFileParameter, and hds::BatchModuleEnumParameter.

const QString& hds::BatchModuleParameter::comment ( ) const

inline

Get comment.

virtual void hds::BatchModuleParameter::info ( ) const

virtual

Print parameter internal data.

Reimplemented in hds::BatchModuleFileParameter, and hds::BatchModuleEnumParameter.

static QString hds::BatchModuleParameter::nameFromType ( Type  type )

static

Name of the parameter from type.

void hds::BatchModuleParameter::setComment ( const QString &  comment )

inline

Set comment.

virtual void hds::BatchModuleParameter::setValue ( const QVariant &  value )

inlinevirtual

Set value.

Reimplemented in hds::BatchModuleFileParameter, and hds::BatchModuleEnumParameter.

virtual Type hds::BatchModuleParameter::type ( ) const

virtual

Get parameter type.

Reimplemented in hds::BatchModuleLDBSeisParameter, hds::BatchModuleFileParameter, and hds::BatchModuleEnumParameter.

static Type hds::BatchModuleParameter::typeFromName ( const QString &  name )

static

Type of the parameter from name.

virtual const QVariant& hds::BatchModuleParameter::value ( ) const

inlinevirtual

Get value.

Reimplemented in hds::BatchModuleFileParameter, and hds::BatchModuleEnumParameter.

Member Data Documentation

QString hds::BatchModuleParameter::m_comment

protected

Commentary.

QVariant hds::BatchModuleParameter::m_value

protected

Parameter's value.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/hds_batch/hds_batch_module_parameter.hpp