hds::BatchModuleEnumParameter Class Reference

#include <hds_batch_module_enum_parameter.hpp>

Inheritance diagram for hds::BatchModuleEnumParameter:

Public Member Functions
	BatchModuleEnumParameter ()
	BatchModuleEnumParameter (const QVariant &value, const QString &comment, const QVariantList &items_list)
virtual BatchModuleParameter *	clone () const
virtual	~BatchModuleEnumParameter ()
virtual const QVariant &	value () const
virtual void	setValue (const QVariant &value)
virtual BatchModuleParameter::Type	type () const
const QVariantList &	itemsList () const
virtual void	info () const
Public Member Functions inherited from hds::BatchModuleParameter
	BatchModuleParameter ()
	BatchModuleParameter (const QVariant &value, const QString &comment)
virtual	~BatchModuleParameter ()
const QString &	comment () const
void	setComment (const QString &comment)

Protected Attributes
QVariantList	m_items_list
Protected Attributes inherited from hds::BatchModuleParameter
QVariant	m_value
QString	m_comment

Additional Inherited Members
Public Types inherited from hds::BatchModuleParameter
enum	Type {   Undefined = 0, Boolean, Integer, Double,   String, StringList, Enum, File,   LDB_Seismic }
Static Public Member Functions inherited from hds::BatchModuleParameter
static QString	nameFromType (Type type)
static Type	typeFromName (const QString &name)

Detailed Description

Enum parameter of the module.

Constructor & Destructor Documentation

hds::BatchModuleEnumParameter::BatchModuleEnumParameter

(

)

Empty enum parameter object.

hds::BatchModuleEnumParameter::BatchModuleEnumParameter	(	const QVariant &	value,
		const QString &	comment,
		const QVariantList &	items_list
	)

Constructor with value, comment and list of items provided. 

Value to be of invalid type if items list is empty or value as current id is out of range.

virtual hds::BatchModuleEnumParameter::~BatchModuleEnumParameter ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Make copy of the object.

Reimplemented from hds::BatchModuleParameter.

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

virtual

Print parameter internal data.

Reimplemented from hds::BatchModuleParameter.

const QVariantList& hds::BatchModuleEnumParameter::itemsList

(

)

const

Get list of items.

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

virtual

Set current selected item as QVariant type. 

Value of selected item will be of invalid type if items list is empty or incorrect value provided (not integer type or out of range).

Reimplemented from hds::BatchModuleParameter.

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

virtual

Get parameter type.

Reimplemented from hds::BatchModuleParameter.

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

virtual

Get current selected item as QVariant of integer type.

Return invalid variant type if object not initialized properly.

Reimplemented from hds::BatchModuleParameter.

Member Data Documentation

QVariantList hds::BatchModuleEnumParameter::m_items_list

protected

< List of enum items.

---

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_enum_parameter.hpp