hds::BatchModuleFileParameter Class Reference

#include <hds_batch_module_file_parameter.hpp>

Inheritance diagram for hds::BatchModuleFileParameter:

Public Types
enum	OpenMode { ReadWrite = 0, ReadOnly, WriteOnly }
Public Types inherited from hds::BatchModuleParameter
enum	Type {   Undefined = 0, Boolean, Integer, Double,   String, StringList, Enum, File,   LDB_Seismic }

Public Member Functions
	BatchModuleFileParameter (OpenMode mode=ReadWrite)
	BatchModuleFileParameter (const QVariant &value, const QString &comment, OpenMode mode=ReadWrite)
virtual BatchModuleParameter *	clone () const
virtual	~BatchModuleFileParameter ()
virtual const QVariant &	value () const
virtual void	setValue (const QVariant &value)
OpenMode	openMode () const
void	setOpenMode (OpenMode mode)
virtual BatchModuleParameter::Type	type () 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
OpenMode	m_open_mode
Protected Attributes inherited from hds::BatchModuleParameter
QVariant	m_value
QString	m_comment

Additional Inherited Members
Static Public Member Functions inherited from hds::BatchModuleParameter
static QString	nameFromType (Type type)
static Type	typeFromName (const QString &name)

Detailed Description

File parameter of the module.

Member Enumeration Documentation

enum hds::BatchModuleFileParameter::OpenMode

The mode in which file to be opened.

Constructor & Destructor Documentation

hds::BatchModuleFileParameter::BatchModuleFileParameter

(

OpenMode

mode = ReadWrite

)

Default constructor.

hds::BatchModuleFileParameter::BatchModuleFileParameter	(	const QVariant &	value,
		const QString &	comment,
		OpenMode	mode = ReadWrite
	)

Constructor with name of the file value and comment.

virtual hds::BatchModuleFileParameter::~BatchModuleFileParameter ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Make copy of the object.

Reimplemented from hds::BatchModuleParameter.

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

virtual

Print parameter internal data.

Reimplemented from hds::BatchModuleParameter.

OpenMode hds::BatchModuleFileParameter::openMode ( ) const

inline

Get current file open mode.

void hds::BatchModuleFileParameter::setOpenMode ( OpenMode  mode )

inline

Set file open mode.

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

virtual

Set current file name.

Reimplemented from hds::BatchModuleParameter.

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

virtual

Get type of the parameter (BatchModuleParameter::File).

Reimplemented from hds::BatchModuleParameter.

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

virtual

Get current file name.

Reimplemented from hds::BatchModuleParameter.

Member Data Documentation

OpenMode hds::BatchModuleFileParameter::m_open_mode

protected

< Current file open mode.

---

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