OpendTect  6.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Attrib::ParamGroup< PT > Class Template Reference

Attrib::Param that contains many (a set) Attrib::Param of one kind. More...

Inheritance diagram for Attrib::ParamGroup< PT >:
[legend]

Public Member Functions

 ParamGroup (const ParamGroup &)
 
 ParamGroup (int startsz, const char *prefix, const PT &templ)
 
 ~ParamGroup ()
 
ParamGroup< PT > * clone () const
 
const char * errMsg () const
 
void fillDefStr (BufferString &) const
 
bool getCompositeValue (BufferString &) const
 
const char * getPrefix () const
 
int isEmpty () const
 
bool isOK () const
 
Paramoperator[] (int idx)
 
const Paramoperator[] (int idx) const
 
void setSize (int)
 
bool setValues (BufferStringSet &)
 
int size () const
 
- Public Member Functions inherited from Attrib::Param
 Param (const char *key)
 
 Param (const Param &)
 
virtual ~Param ()
 
virtual BufferString getDefaultValue () const
 
FixedString getKey () const
 
bool isEnabled () const
 
bool isGroup () const
 
bool isRequired () const
 
bool operator!= (const Param &p) const
 
bool operator== (const Param &p) const
 
virtual bool setCompositeValue (const char *)
 
void setEnabled (bool yn=true)
 
void setKey (const char *newkey)
 
void setRequired (bool yn=true)
 

Protected Member Functions

int getSize () const
 
bool isEqual (const Param &) const
 
- Protected Member Functions inherited from Attrib::Param
bool _isEqual (const Param &p) const
 

Protected Attributes

BufferString errmsg_
 
ObjectSet< PT > params_
 
const BufferString prefix_
 
int sz_
 
PT templ_
 
- Protected Attributes inherited from Attrib::Param
bool enabled_
 
bool isgroup_
 
BufferString key_
 
bool required_
 

Detailed Description

template<class PT>
class Attrib::ParamGroup< PT >

Attrib::Param that contains many (a set) Attrib::Param of one kind.

It's made for parameters where you don't know how many are required. An example can be positions, where the number of positions are unknown at the beginning of parsing.

The Attrib::ParamGroup have a prefix and constructs parameter names on the form prefix + figure:

pos0, pos1, ..., posN.

The Attrib::ParamGroup is constructed by: Attrib::ParamGroup( int startsz, const char* prefix, const PT& templ ),

where startsz is the number of instances at the beginning, templ is a a template for the parameters that should be constructed.

Constructor & Destructor Documentation

◆ ParamGroup() [1/2]

template<class PT >
Attrib::ParamGroup< PT >::ParamGroup ( int  startsz,
const char *  prefix,
const PT &  templ 
)
inline

◆ ParamGroup() [2/2]

template<class PT >
Attrib::ParamGroup< PT >::ParamGroup ( const ParamGroup< PT > &  a)
inline

◆ ~ParamGroup()

template<class PT >
Attrib::ParamGroup< PT >::~ParamGroup
inline

Member Function Documentation

◆ clone()

template<class PT >
ParamGroup< PT > * Attrib::ParamGroup< PT >::clone
inlinevirtual

Implements Attrib::Param.

◆ errMsg()

template<class PT >
const char * Attrib::ParamGroup< PT >::errMsg
inline

◆ fillDefStr()

template<class PT >
void Attrib::ParamGroup< PT >::fillDefStr ( BufferString res) const
inlinevirtual

Implements Attrib::Param.

◆ getCompositeValue()

template<class PT >
bool Attrib::ParamGroup< PT >::getCompositeValue ( BufferString ) const
inlinevirtual

Put all values into one string.

Implements Attrib::Param.

◆ getPrefix()

template<class PT >
const char* Attrib::ParamGroup< PT >::getPrefix ( ) const
inline

◆ getSize()

template<class PT >
int Attrib::ParamGroup< PT >::getSize
inlineprotected

◆ isEmpty()

template<class PT >
int Attrib::ParamGroup< PT >::isEmpty ( ) const
inline

◆ isEqual()

template<class PT >
bool Attrib::ParamGroup< PT >::isEqual ( const Param b) const
inlineprotectedvirtual

Implements Attrib::Param.

◆ isOK()

template<class PT >
bool Attrib::ParamGroup< PT >::isOK
inlinevirtual

Implements Attrib::Param.

◆ operator[]() [1/2]

template<class PT >
Param& Attrib::ParamGroup< PT >::operator[] ( int  idx)
inline

◆ operator[]() [2/2]

template<class PT >
const Param& Attrib::ParamGroup< PT >::operator[] ( int  idx) const
inline

◆ setSize()

template<class PT >
void Attrib::ParamGroup< PT >::setSize ( int  nsz)
inline

◆ setValues()

template<class PT >
bool Attrib::ParamGroup< PT >::setValues ( BufferStringSet )
inlinevirtual

Set all values from multiple strings.

Reimplemented from Attrib::Param.

◆ size()

template<class PT >
int Attrib::ParamGroup< PT >::size ( ) const
inline

Member Data Documentation

◆ errmsg_

template<class PT >
BufferString Attrib::ParamGroup< PT >::errmsg_
protected

◆ params_

template<class PT >
ObjectSet<PT> Attrib::ParamGroup< PT >::params_
protected

◆ prefix_

template<class PT >
const BufferString Attrib::ParamGroup< PT >::prefix_
protected

◆ sz_

template<class PT >
int Attrib::ParamGroup< PT >::sz_
protected

◆ templ_

template<class PT >
PT Attrib::ParamGroup< PT >::templ_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022