OpendTect  6.6
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IOPar Class Reference

Generalized set of parameters of the keyword-value type. More...

Inheritance diagram for IOPar:
[legend]

Public Member Functions

 IOPar (ascistream &)
 
 IOPar (const char *nm=nullptr)
 empty More...
 
 IOPar (const IOPar &)
 
 ~IOPar ()
 
void add (const char *, double)
 
void add (const char *, double, double)
 
void add (const char *, double, double, double)
 
void add (const char *, double, double, double, double)
 
void add (const char *, float)
 
void add (const char *, float, float)
 
void add (const char *, float, float, float)
 
void add (const char *, float, float, float, float)
 
void add (const char *, int)
 
void add (const char *, int, int)
 
void add (const char *, int, int, int)
 
void add (const char *, int, int, int, int)
 
void add (const char *, int64_t)
 
void add (const char *, int64_t, int64_t)
 
void add (const char *, int64_t, int64_t, int64_t)
 
void add (const char *, int64_t, int64_t, int64_t, int64_t)
 
void add (const char *, short)
 
void add (const char *, short, short)
 
void add (const char *, short, short, short)
 
void add (const char *, short, short, short, short)
 
void add (const char *, uint64_t)
 
void add (const char *, uint64_t, uint64_t)
 
void add (const char *, uint64_t, uint64_t, uint64_t)
 
void add (const char *, uint64_t, uint64_t, uint64_t, uint64_t)
 
void add (const char *, unsigned int)
 
void add (const char *, unsigned int, unsigned int)
 
void add (const char *, unsigned int, unsigned int, unsigned int)
 
void add (const char *, unsigned int, unsigned int, unsigned int, unsigned int)
 
void add (const char *, unsigned short)
 
void add (const char *, unsigned short, unsigned short)
 
void add (const char *, unsigned short, unsigned short, unsigned short)
 
void add (const char *, unsigned short, unsigned short, unsigned short, unsigned short)
 
void add (const char *ky, const char *val)
 
void add (const char *ky, const OD::String &val)
 
void addFrom (const IOPar &)
 merge entries but do not overwrite More...
 
void addVal (const char *ky, const char *valtoadd)
 
void addYN (const char *, bool)
 
void addYN (const char *, bool, bool)
 
void addYN (const char *, bool, bool, bool)
 
void addYN (const char *, bool, bool, bool, bool)
 
void dumpPretty (BufferString &) const
 
void dumpPretty (od_ostream &) const
 
void fillJSON (OD::JSON::Object &obj)
 only save the top level objects More...
 
const char * find (const char *) const
 returns null if not found More...
 
const char * findKeyFor (const char *, int nr=0) const
 returns null if value not found More...
 
bool get (const char *, BinID &) const
 
bool get (const char *, BoolTypeSet &) const
 
bool get (const char *, BufferString &) const
 
bool get (const char *, BufferString &, BufferString &) const
 
bool get (const char *, BufferString &, BufferString &, BufferString &) const
 
bool get (const char *, BufferStringSet &) const
 
bool get (const char *, Color &) const
 
bool get (const char *, Coord &) const
 
bool get (const char *, Coord3 &) const
 
bool get (const char *, DBKey &) const
 
bool get (const char *, DBKeySet &) const
 
bool get (const char *, double &) const
 
bool get (const char *, double &, double &) const
 
bool get (const char *, double &, double &, double &) const
 
bool get (const char *, double &, double &, double &, double &) const
 
bool get (const char *, float &) const
 
bool get (const char *, float &, float &) const
 
bool get (const char *, float &, float &, float &) const
 
bool get (const char *, float &, float &, float &, float &) const
 
bool get (const char *, int &) const
 
bool get (const char *, int &, int &) const
 
bool get (const char *, int &, int &, float &) const
 
bool get (const char *, int &, int &, int &) const
 
bool get (const char *, int &, int &, int &, int &) const
 
bool get (const char *, int64_t &) const
 
bool get (const char *, int64_t &, int64_t &) const
 
bool get (const char *, int64_t &, int64_t &, int64_t &) const
 
bool get (const char *, int64_t &, int64_t &, int64_t &, int64_t &) const
 
template<class T >
bool get (const char *, Interval< T > &) const
 
bool get (const char *, MultiID &) const
 
template<class T >
bool get (const char *, SamplingData< T > &) const
 
bool get (const char *, SeparString &) const
 
bool get (const char *, short &) const
 
bool get (const char *, short &, short &) const
 
bool get (const char *, short &, short &, short &) const
 
bool get (const char *, short &, short &, short &, short &) const
 
bool get (const char *, TrcKey &) const
 
bool get (const char *, TypeSet< double > &) const
 
bool get (const char *, TypeSet< float > &) const
 
bool get (const char *, TypeSet< int > &) const
 
bool get (const char *, TypeSet< int64_t > &) const
 
bool get (const char *, TypeSet< MultiID > &) const
 
bool get (const char *, TypeSet< short > &) const
 
bool get (const char *, TypeSet< uint64_t > &) const
 
bool get (const char *, TypeSet< unsigned int > &) const
 
bool get (const char *, TypeSet< unsigned short > &) const
 
bool get (const char *, uint64_t &) const
 
bool get (const char *, uint64_t &, uint64_t &) const
 
bool get (const char *, uint64_t &, uint64_t &, uint64_t &) const
 
bool get (const char *, uint64_t &, uint64_t &, uint64_t &, uint64_t &) const
 
bool get (const char *, uiString &) const
 
bool get (const char *, unsigned int &) const
 
bool get (const char *, unsigned int &, unsigned int &) const
 
bool get (const char *, unsigned int &, unsigned int &, unsigned int &) const
 
bool get (const char *, unsigned int &, unsigned int &, unsigned int &, unsigned int &) const
 
bool get (const char *, unsigned short &) const
 
bool get (const char *, unsigned short &, unsigned short &) const
 
bool get (const char *, unsigned short &, unsigned short &, unsigned short &) const
 
bool get (const char *, unsigned short &, unsigned short &, unsigned short &, unsigned short &) const
 
void getFrom (ascistream &)
 
void getFrom (const char *)
 
FixedString getKey (int) const
 
void getParsFrom (const char *)
 
bool getPtr (const char *, void *&) const
 
bool getScaled (const char *, double &, double &, double &, double &, double, bool) const
 
bool getScaled (const char *, double &, double &, double &, double, bool) const
 
bool getScaled (const char *, double &, double &, double, bool) const
 
bool getScaled (const char *, double &, double applied_scale, bool set_to_undef_if_not_found) const
 
bool getScaled (const char *, float &, float &, float &, float &, float, bool) const
 
bool getScaled (const char *, float &, float &, float &, float, bool) const
 
bool getScaled (const char *, float &, float &, float, bool) const
 
bool getScaled (const char *, float &, float applied_scale, bool set_to_undef_if_not_found) const
 
FixedString getValue (int) const
 
bool getYN (const char *, bool &) const
 
bool getYN (const char *, bool &, bool &) const
 
bool getYN (const char *, bool &, bool &, bool &) const
 
bool getYN (const char *, bool &, bool &, bool &, bool &) const
 
bool hasKey (const char *s) const
 
bool includes (const IOPar &) const
 
int indexOf (const char *key) const
 
bool isEmpty () const
 
bool isEqual (const IOPar &, bool need_same_order=false) const
 
bool isFalse (const char *key) const
 
bool isPresent (const char *ky) const
 
bool isTrue (const char *key) const
 
int majorVersion () const
 Only set if read from file. Otherwise set to current. More...
 
int maxContentSize (bool keys_else_values) const
 
void merge (const IOPar &)
 merge entries using the set() command More...
 
void mergeComp (const IOPar &, const char *)
 merge entries, where IOPar's entries get a prefix More...
 
int minorVersion () const
 Only set if read from file. Otherwise set to current. More...
 
int odVersion () const
 
bool operator!= (const IOPar &iop) const
 
IOParoperator= (const IOPar &)
 
bool operator== (const IOPar &iop) const
 
FixedString operator[] (const char *ky) const
 
int patchVersion () const
 Only set if read from file. Otherwise set to current. More...
 
void putParsTo (BufferString &) const
 
void putTo (ascostream &) const
 
void putTo (BufferString &) const
 
bool read (const char *filename, const char *filetype, bool chktype=false)
 
bool read (od_istream &, const char *filetype, bool chktype=false)
 
void remove (int)
 
void removeSubSelection (const char *str)
 removes with key that start with str. More...
 
void removeSubSelection (const OD::String &fs)
 
void removeSubSelection (int)
 removes with key that start with number. More...
 
void removeWithKey (const char *key)
 
void removeWithKeyPattern (const char *globexpression)
 
void set (const char *, const BinID &)
 
void set (const char *, const BoolTypeSet &)
 
void set (const char *, const BufferStringSet &)
 
void set (const char *, const char *, const char *)
 
void set (const char *, const char *, const char *, const char *)
 
void set (const char *, const Color &)
 
void set (const char *, const Coord &)
 
void set (const char *, const Coord3 &)
 
void set (const char *, const DBKey &)
 
void set (const char *, const DBKeySet &)
 
template<class T >
void set (const char *, const Interval< T > &)
 
void set (const char *, const MultiID &)
 
void set (const char *, const OD::String &)
 
void set (const char *, const OD::String &, const OD::String &)
 
void set (const char *, const OD::String &, const OD::String &, const OD::String &)
 
template<class T >
void set (const char *, const SamplingData< T > &)
 
void set (const char *, const SeparString &)
 
void set (const char *, const TrcKey &)
 
void set (const char *, const TypeSet< double > &)
 
void set (const char *, const TypeSet< float > &)
 
void set (const char *, const TypeSet< int > &)
 
void set (const char *, const TypeSet< int64_t > &)
 
void set (const char *, const TypeSet< MultiID > &)
 
void set (const char *, const TypeSet< short > &)
 
void set (const char *, const TypeSet< uint64_t > &)
 
void set (const char *, const TypeSet< unsigned int > &)
 
void set (const char *, const TypeSet< unsigned short > &)
 
void set (const char *, const uiString &)
 
void set (const char *, double)
 
void set (const char *, double, double)
 
void set (const char *, double, double, double)
 
void set (const char *, double, double, double, double)
 
void set (const char *, float)
 
void set (const char *, float, float)
 
void set (const char *, float, float, float)
 
void set (const char *, float, float, float, float)
 
void set (const char *, int)
 
void set (const char *, int, int)
 
void set (const char *, int, int, float)
 
void set (const char *, int, int, int)
 
void set (const char *, int, int, int, int)
 
void set (const char *, int64_t)
 
void set (const char *, int64_t, int64_t)
 
void set (const char *, int64_t, int64_t, int64_t)
 
void set (const char *, int64_t, int64_t, int64_t, int64_t)
 
void set (const char *, short)
 
void set (const char *, short, short)
 
void set (const char *, short, short, short)
 
void set (const char *, short, short, short, short)
 
void set (const char *, uint64_t)
 
void set (const char *, uint64_t, uint64_t)
 
void set (const char *, uint64_t, uint64_t, uint64_t)
 
void set (const char *, uint64_t, uint64_t, uint64_t, uint64_t)
 
void set (const char *, unsigned int)
 
void set (const char *, unsigned int, unsigned int)
 
void set (const char *, unsigned int, unsigned int, unsigned int)
 
void set (const char *, unsigned int, unsigned int, unsigned int, unsigned int)
 
void set (const char *, unsigned short)
 
void set (const char *, unsigned short, unsigned short)
 
void set (const char *, unsigned short, unsigned short, unsigned short)
 
void set (const char *, unsigned short, unsigned short, unsigned short, unsigned short)
 
void set (const char *ky, const char *val)
 
void setEmpty ()
 remove all entries (doesn't clear name) More...
 
bool setKey (int, const char *)
 
void setPtr (const char *, void *)
 
void setStdCreationEntries ()
 
void setToDateTime (const char *ky=nullptr)
 
void setToUser (const char *ky=nullptr)
 
void setValue (int, const char *)
 
void setYN (const char *, bool)
 
void setYN (const char *, bool, bool)
 
void setYN (const char *, bool, bool, bool)
 
void setYN (const char *, bool, bool, bool, bool)
 
int size () const
 
IOParsubselect (const char *str) const
 returns iopar with key that start with str. More...
 
IOParsubselect (const OD::String &fs) const
 
IOParsubselect (int) const
 returns iopar with key that start with number. More...
 
void update (const char *ky, const char *val)
 
bool write (const char *filename, const char *filetype) const
 
bool write (od_ostream &, const char *filetyp) const
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=nullptr)
 
 NamedObject (const NamedObject &oth)
 
virtual ~NamedObject ()
 
virtual BufferString getName () const
 
bool getNameFromPar (const IOPar &)
 
virtual const name_typename () const
 
NamedObjectoperator= (const NamedObject &)
 
bool operator== (const NamedObject &oth) const
 
virtual void setName (const char *nm)
 
- Public Member Functions inherited from ObjectWithName
virtual ~ObjectWithName ()
 
bool hasName (const char *nm) const
 
bool hasName (const name_type &nm) const
 
void putNameInPar (IOPar &) const
 

Static Public Member Functions

static const char * compKey (const char *, const char *)
 The composite key: (a,b) -> a.b. More...
 
static const char * compKey (const char *, int)
 The composite key where int will be --> string. More...
 
static const char * compKey (const char *ky1, const OD::String &ky2)
 
static const char * sKeyDumpPretty ()
 
static const char * sKeyHdr ()
 
static const char * sKeySubHdr ()
 

Protected Member Functions

void setPatchVersion (int)
 

Protected Attributes

BufferStringSetkeys_
 
int majorversion_
 
int minorversion_
 
BufferStringSetvals_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 

Additional Inherited Members

- Public Types inherited from ObjectWithName
typedef OD::String name_type
 

Detailed Description

Generalized set of parameters of the keyword-value type.

Part of the function of this class is as in an STL map<string,string>. Passing a keyword will return the appropriate value.

Tools around this basic idea are paring into other types, key composition, reading/writing to/from file, merging, and more.

The get() functions return a bool, which is false when: either the key is not present or the value is not acceptable (usually: when empty is not OK, like for numerical values). In that case the passed variable is untouched; it keeps its original value.

dumpPretty() is used for reports. The title of the report is the name of the IOPar. If sKeyHdr and sKeySubHdr are the key, there will be a (sub)header with the value. Use add() rather than set(). Values may contain newlines.

<>

Constructor & Destructor Documentation

◆ IOPar() [1/3]

IOPar::IOPar ( const char *  nm = nullptr)

empty

◆ IOPar() [2/3]

IOPar::IOPar ( ascistream )

◆ IOPar() [3/3]

IOPar::IOPar ( const IOPar )

◆ ~IOPar()

IOPar::~IOPar ( )

Member Function Documentation

◆ add() [1/34]

void IOPar::add ( const char *  ,
double   
)

◆ add() [2/34]

void IOPar::add ( const char *  ,
double  ,
double   
)

◆ add() [3/34]

void IOPar::add ( const char *  ,
double  ,
double  ,
double   
)

◆ add() [4/34]

void IOPar::add ( const char *  ,
double  ,
double  ,
double  ,
double   
)

◆ add() [5/34]

void IOPar::add ( const char *  ,
float   
)

◆ add() [6/34]

void IOPar::add ( const char *  ,
float  ,
float   
)

◆ add() [7/34]

void IOPar::add ( const char *  ,
float  ,
float  ,
float   
)

◆ add() [8/34]

void IOPar::add ( const char *  ,
float  ,
float  ,
float  ,
float   
)

◆ add() [9/34]

void IOPar::add ( const char *  ,
int   
)

◆ add() [10/34]

void IOPar::add ( const char *  ,
int  ,
int   
)

◆ add() [11/34]

void IOPar::add ( const char *  ,
int  ,
int  ,
int   
)

◆ add() [12/34]

void IOPar::add ( const char *  ,
int  ,
int  ,
int  ,
int   
)

◆ add() [13/34]

void IOPar::add ( const char *  ,
int64_t   
)

◆ add() [14/34]

void IOPar::add ( const char *  ,
int64_t  ,
int64_t   
)

◆ add() [15/34]

void IOPar::add ( const char *  ,
int64_t  ,
int64_t  ,
int64_t   
)

◆ add() [16/34]

void IOPar::add ( const char *  ,
int64_t  ,
int64_t  ,
int64_t  ,
int64_t   
)

◆ add() [17/34]

void IOPar::add ( const char *  ,
short   
)

◆ add() [18/34]

void IOPar::add ( const char *  ,
short  ,
short   
)

◆ add() [19/34]

void IOPar::add ( const char *  ,
short  ,
short  ,
short   
)

◆ add() [20/34]

void IOPar::add ( const char *  ,
short  ,
short  ,
short  ,
short   
)

◆ add() [21/34]

void IOPar::add ( const char *  ,
uint64_t   
)

◆ add() [22/34]

void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t   
)

◆ add() [23/34]

void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)

◆ add() [24/34]

void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)

◆ add() [25/34]

void IOPar::add ( const char *  ,
unsigned int   
)

◆ add() [26/34]

void IOPar::add ( const char *  ,
unsigned int  ,
unsigned int   
)

◆ add() [27/34]

void IOPar::add ( const char *  ,
unsigned int  ,
unsigned int  ,
unsigned int   
)

◆ add() [28/34]

void IOPar::add ( const char *  ,
unsigned int  ,
unsigned int  ,
unsigned int  ,
unsigned int   
)

◆ add() [29/34]

void IOPar::add ( const char *  ,
unsigned short   
)

◆ add() [30/34]

void IOPar::add ( const char *  ,
unsigned short  ,
unsigned short   
)

◆ add() [31/34]

void IOPar::add ( const char *  ,
unsigned short  ,
unsigned short  ,
unsigned short   
)

◆ add() [32/34]

void IOPar::add ( const char *  ,
unsigned short  ,
unsigned short  ,
unsigned short  ,
unsigned short   
)

◆ add() [33/34]

void IOPar::add ( const char *  ky,
const char *  val 
)

unsafe: does not check for duplicate keys

◆ add() [34/34]

void IOPar::add ( const char *  ky,
const OD::String val 
)
inline

◆ addFrom()

void IOPar::addFrom ( const IOPar )

merge entries but do not overwrite

◆ addVal()

void IOPar::addVal ( const char *  ky,
const char *  valtoadd 
)

Append valtoadd to existing vals: ky: <existing vals>`valtoadd

◆ addYN() [1/4]

void IOPar::addYN ( const char *  ,
bool   
)

◆ addYN() [2/4]

void IOPar::addYN ( const char *  ,
bool  ,
bool   
)

◆ addYN() [3/4]

void IOPar::addYN ( const char *  ,
bool  ,
bool  ,
bool   
)

◆ addYN() [4/4]

void IOPar::addYN ( const char *  ,
bool  ,
bool  ,
bool  ,
bool   
)

◆ compKey() [1/3]

static const char* IOPar::compKey ( const char *  ,
const char *   
)
static

The composite key: (a,b) -> a.b.

◆ compKey() [2/3]

static const char* IOPar::compKey ( const char *  ,
int   
)
static

The composite key where int will be --> string.

◆ compKey() [3/3]

static const char* IOPar::compKey ( const char *  ky1,
const OD::String ky2 
)
inlinestatic

◆ dumpPretty() [1/2]

void IOPar::dumpPretty ( BufferString ) const

◆ dumpPretty() [2/2]

void IOPar::dumpPretty ( od_ostream ) const

◆ fillJSON()

void IOPar::fillJSON ( OD::JSON::Object obj)

only save the top level objects

◆ find()

const char* IOPar::find ( const char *  ) const

returns null if not found

◆ findKeyFor()

const char* IOPar::findKeyFor ( const char *  ,
int  nr = 0 
) const

returns null if value not found

◆ get() [1/59]

bool IOPar::get ( const char *  ,
BinID  
) const

◆ get() [2/59]

bool IOPar::get ( const char *  ,
BoolTypeSet  
) const

◆ get() [3/59]

bool IOPar::get ( const char *  ,
BufferString  
) const

◆ get() [4/59]

bool IOPar::get ( const char *  ,
BufferString ,
BufferString  
) const

◆ get() [5/59]

bool IOPar::get ( const char *  ,
BufferString ,
BufferString ,
BufferString  
) const

◆ get() [6/59]

bool IOPar::get ( const char *  ,
BufferStringSet  
) const

◆ get() [7/59]

bool IOPar::get ( const char *  ,
Color  
) const

◆ get() [8/59]

bool IOPar::get ( const char *  ,
Coord  
) const

◆ get() [9/59]

bool IOPar::get ( const char *  ,
Coord3  
) const

◆ get() [10/59]

bool IOPar::get ( const char *  ,
DBKey  
) const

◆ get() [11/59]

bool IOPar::get ( const char *  ,
DBKeySet  
) const

◆ get() [12/59]

bool IOPar::get ( const char *  ,
double &   
) const

◆ get() [13/59]

bool IOPar::get ( const char *  ,
double &  ,
double &   
) const

◆ get() [14/59]

bool IOPar::get ( const char *  ,
double &  ,
double &  ,
double &   
) const

◆ get() [15/59]

bool IOPar::get ( const char *  ,
double &  ,
double &  ,
double &  ,
double &   
) const

◆ get() [16/59]

bool IOPar::get ( const char *  ,
float &   
) const

◆ get() [17/59]

bool IOPar::get ( const char *  ,
float &  ,
float &   
) const

◆ get() [18/59]

bool IOPar::get ( const char *  ,
float &  ,
float &  ,
float &   
) const

◆ get() [19/59]

bool IOPar::get ( const char *  ,
float &  ,
float &  ,
float &  ,
float &   
) const

◆ get() [20/59]

bool IOPar::get ( const char *  ,
int &   
) const

◆ get() [21/59]

bool IOPar::get ( const char *  ,
int &  ,
int &   
) const

◆ get() [22/59]

bool IOPar::get ( const char *  ,
int &  ,
int &  ,
float &   
) const

◆ get() [23/59]

bool IOPar::get ( const char *  ,
int &  ,
int &  ,
int &   
) const

◆ get() [24/59]

bool IOPar::get ( const char *  ,
int &  ,
int &  ,
int &  ,
int &   
) const

◆ get() [25/59]

bool IOPar::get ( const char *  ,
int64_t &   
) const

◆ get() [26/59]

bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &   
) const

◆ get() [27/59]

bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &  ,
int64_t &   
) const

◆ get() [28/59]

bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &  ,
int64_t &  ,
int64_t &   
) const

◆ get() [29/59]

template<class T >
bool IOPar::get ( const char *  k,
Interval< T > &  i 
) const
inline

◆ get() [30/59]

bool IOPar::get ( const char *  ,
MultiID  
) const

◆ get() [31/59]

template<class T >
bool IOPar::get ( const char *  k,
SamplingData< T > &  sd 
) const
inline

◆ get() [32/59]

bool IOPar::get ( const char *  ,
SeparString  
) const

◆ get() [33/59]

bool IOPar::get ( const char *  ,
short &   
) const

◆ get() [34/59]

bool IOPar::get ( const char *  ,
short &  ,
short &   
) const

◆ get() [35/59]

bool IOPar::get ( const char *  ,
short &  ,
short &  ,
short &   
) const

◆ get() [36/59]

bool IOPar::get ( const char *  ,
short &  ,
short &  ,
short &  ,
short &   
) const

◆ get() [37/59]

bool IOPar::get ( const char *  ,
TrcKey  
) const

◆ get() [38/59]

bool IOPar::get ( const char *  ,
TypeSet< double > &   
) const

◆ get() [39/59]

bool IOPar::get ( const char *  ,
TypeSet< float > &   
) const

◆ get() [40/59]

bool IOPar::get ( const char *  ,
TypeSet< int > &   
) const

◆ get() [41/59]

bool IOPar::get ( const char *  ,
TypeSet< int64_t > &   
) const

◆ get() [42/59]

bool IOPar::get ( const char *  ,
TypeSet< MultiID > &   
) const

◆ get() [43/59]

bool IOPar::get ( const char *  ,
TypeSet< short > &   
) const

◆ get() [44/59]

bool IOPar::get ( const char *  ,
TypeSet< uint64_t > &   
) const

◆ get() [45/59]

bool IOPar::get ( const char *  ,
TypeSet< unsigned int > &   
) const

◆ get() [46/59]

bool IOPar::get ( const char *  ,
TypeSet< unsigned short > &   
) const

◆ get() [47/59]

bool IOPar::get ( const char *  ,
uint64_t &   
) const

◆ get() [48/59]

bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &   
) const

◆ get() [49/59]

bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &   
) const

◆ get() [50/59]

bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &   
) const

◆ get() [51/59]

bool IOPar::get ( const char *  ,
uiString  
) const

◆ get() [52/59]

bool IOPar::get ( const char *  ,
unsigned int &   
) const

◆ get() [53/59]

bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &   
) const

◆ get() [54/59]

bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
) const

◆ get() [55/59]

bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
) const

◆ get() [56/59]

bool IOPar::get ( const char *  ,
unsigned short &   
) const

◆ get() [57/59]

bool IOPar::get ( const char *  ,
unsigned short &  ,
unsigned short &   
) const

◆ get() [58/59]

bool IOPar::get ( const char *  ,
unsigned short &  ,
unsigned short &  ,
unsigned short &   
) const

◆ get() [59/59]

bool IOPar::get ( const char *  ,
unsigned short &  ,
unsigned short &  ,
unsigned short &  ,
unsigned short &   
) const

◆ getFrom() [1/2]

void IOPar::getFrom ( ascistream )

◆ getFrom() [2/2]

void IOPar::getFrom ( const char *  )

◆ getKey()

FixedString IOPar::getKey ( int  ) const

◆ getParsFrom()

void IOPar::getParsFrom ( const char *  )

◆ getPtr()

bool IOPar::getPtr ( const char *  ,
void *&   
) const

◆ getScaled() [1/8]

bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double &  ,
double &  ,
double  ,
bool   
) const

◆ getScaled() [2/8]

bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double &  ,
double  ,
bool   
) const

◆ getScaled() [3/8]

bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double  ,
bool   
) const

◆ getScaled() [4/8]

bool IOPar::getScaled ( const char *  ,
double &  ,
double  applied_scale,
bool  set_to_undef_if_not_found 
) const

◆ getScaled() [5/8]

bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float &  ,
float &  ,
float  ,
bool   
) const

◆ getScaled() [6/8]

bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float &  ,
float  ,
bool   
) const

◆ getScaled() [7/8]

bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float  ,
bool   
) const

◆ getScaled() [8/8]

bool IOPar::getScaled ( const char *  ,
float &  ,
float  applied_scale,
bool  set_to_undef_if_not_found 
) const

◆ getValue()

FixedString IOPar::getValue ( int  ) const

◆ getYN() [1/4]

bool IOPar::getYN ( const char *  ,
bool &   
) const

◆ getYN() [2/4]

bool IOPar::getYN ( const char *  ,
bool &  ,
bool &   
) const

◆ getYN() [3/4]

bool IOPar::getYN ( const char *  ,
bool &  ,
bool &  ,
bool &   
) const

◆ getYN() [4/4]

bool IOPar::getYN ( const char *  ,
bool &  ,
bool &  ,
bool &  ,
bool &   
) const

◆ hasKey()

bool IOPar::hasKey ( const char *  s) const
inline

◆ includes()

bool IOPar::includes ( const IOPar ) const

◆ indexOf()

int IOPar::indexOf ( const char *  key) const

◆ isEmpty()

bool IOPar::isEmpty ( ) const
inline

◆ isEqual()

bool IOPar::isEqual ( const IOPar ,
bool  need_same_order = false 
) const

◆ isFalse()

bool IOPar::isFalse ( const char *  key) const
inline

◆ isPresent()

bool IOPar::isPresent ( const char *  ky) const
inline

◆ isTrue()

bool IOPar::isTrue ( const char *  key) const
inline

◆ majorVersion()

int IOPar::majorVersion ( ) const
inline

Only set if read from file. Otherwise set to current.

◆ maxContentSize()

int IOPar::maxContentSize ( bool  keys_else_values) const

◆ merge()

void IOPar::merge ( const IOPar )

merge entries using the set() command

◆ mergeComp()

void IOPar::mergeComp ( const IOPar ,
const char *   
)

merge entries, where IOPar's entries get a prefix

◆ minorVersion()

int IOPar::minorVersion ( ) const
inline

Only set if read from file. Otherwise set to current.

◆ odVersion()

int IOPar::odVersion ( ) const

Only set if read from file. Otherwise set to current v6.6.0 returns as 660

◆ operator!=()

bool IOPar::operator!= ( const IOPar iop) const
inline

◆ operator=()

IOPar& IOPar::operator= ( const IOPar )

◆ operator==()

bool IOPar::operator== ( const IOPar iop) const
inline

◆ operator[]()

FixedString IOPar::operator[] ( const char *  ky) const
inline

◆ patchVersion()

int IOPar::patchVersion ( ) const

Only set if read from file. Otherwise set to current.

◆ putParsTo()

void IOPar::putParsTo ( BufferString ) const

◆ putTo() [1/2]

void IOPar::putTo ( ascostream ) const

◆ putTo() [2/2]

void IOPar::putTo ( BufferString ) const

◆ read() [1/2]

bool IOPar::read ( const char *  filename,
const char *  filetype,
bool  chktype = false 
)

filetype null will assume no file header uses set(). no clear() done

◆ read() [2/2]

bool IOPar::read ( od_istream ,
const char *  filetype,
bool  chktype = false 
)

◆ remove()

void IOPar::remove ( int  )

◆ removeSubSelection() [1/3]

void IOPar::removeSubSelection ( const char *  str)

removes with key that start with str.

◆ removeSubSelection() [2/3]

void IOPar::removeSubSelection ( const OD::String fs)
inline

◆ removeSubSelection() [3/3]

void IOPar::removeSubSelection ( int  )

removes with key that start with number.

◆ removeWithKey()

void IOPar::removeWithKey ( const char *  key)

◆ removeWithKeyPattern()

void IOPar::removeWithKeyPattern ( const char *  globexpression)

removes all entries with key matching this glob expression

◆ set() [1/62]

void IOPar::set ( const char *  ,
const BinID  
)

◆ set() [2/62]

void IOPar::set ( const char *  ,
const BoolTypeSet  
)

◆ set() [3/62]

void IOPar::set ( const char *  ,
const BufferStringSet  
)

◆ set() [4/62]

void IOPar::set ( const char *  ,
const char *  ,
const char *   
)

◆ set() [5/62]

void IOPar::set ( const char *  ,
const char *  ,
const char *  ,
const char *   
)

◆ set() [6/62]

void IOPar::set ( const char *  ,
const Color  
)

◆ set() [7/62]

void IOPar::set ( const char *  ,
const Coord  
)

◆ set() [8/62]

void IOPar::set ( const char *  ,
const Coord3  
)

◆ set() [9/62]

void IOPar::set ( const char *  ,
const DBKey  
)

◆ set() [10/62]

void IOPar::set ( const char *  ,
const DBKeySet  
)

◆ set() [11/62]

template<class T >
void IOPar::set ( const char *  k,
const Interval< T > &  i 
)
inline

◆ set() [12/62]

void IOPar::set ( const char *  ,
const MultiID  
)

◆ set() [13/62]

void IOPar::set ( const char *  ,
const OD::String  
)

◆ set() [14/62]

void IOPar::set ( const char *  ,
const OD::String ,
const OD::String  
)

◆ set() [15/62]

void IOPar::set ( const char *  ,
const OD::String ,
const OD::String ,
const OD::String  
)

◆ set() [16/62]

template<class T >
void IOPar::set ( const char *  k,
const SamplingData< T > &  sd 
)
inline

◆ set() [17/62]

void IOPar::set ( const char *  ,
const SeparString  
)

◆ set() [18/62]

void IOPar::set ( const char *  ,
const TrcKey  
)

◆ set() [19/62]

void IOPar::set ( const char *  ,
const TypeSet< double > &   
)

◆ set() [20/62]

void IOPar::set ( const char *  ,
const TypeSet< float > &   
)

◆ set() [21/62]

void IOPar::set ( const char *  ,
const TypeSet< int > &   
)

◆ set() [22/62]

void IOPar::set ( const char *  ,
const TypeSet< int64_t > &   
)

◆ set() [23/62]

void IOPar::set ( const char *  ,
const TypeSet< MultiID > &   
)

◆ set() [24/62]

void IOPar::set ( const char *  ,
const TypeSet< short > &   
)

◆ set() [25/62]

void IOPar::set ( const char *  ,
const TypeSet< uint64_t > &   
)

◆ set() [26/62]

void IOPar::set ( const char *  ,
const TypeSet< unsigned int > &   
)

◆ set() [27/62]

void IOPar::set ( const char *  ,
const TypeSet< unsigned short > &   
)

◆ set() [28/62]

void IOPar::set ( const char *  ,
const uiString  
)

◆ set() [29/62]

void IOPar::set ( const char *  ,
double   
)

◆ set() [30/62]

void IOPar::set ( const char *  ,
double  ,
double   
)

◆ set() [31/62]

void IOPar::set ( const char *  ,
double  ,
double  ,
double   
)

◆ set() [32/62]

void IOPar::set ( const char *  ,
double  ,
double  ,
double  ,
double   
)

◆ set() [33/62]

void IOPar::set ( const char *  ,
float   
)

◆ set() [34/62]

void IOPar::set ( const char *  ,
float  ,
float   
)

◆ set() [35/62]

void IOPar::set ( const char *  ,
float  ,
float  ,
float   
)

◆ set() [36/62]

void IOPar::set ( const char *  ,
float  ,
float  ,
float  ,
float   
)

◆ set() [37/62]

void IOPar::set ( const char *  ,
int   
)

◆ set() [38/62]

void IOPar::set ( const char *  ,
int  ,
int   
)

◆ set() [39/62]

void IOPar::set ( const char *  ,
int  ,
int  ,
float   
)

◆ set() [40/62]

void IOPar::set ( const char *  ,
int  ,
int  ,
int   
)

◆ set() [41/62]

void IOPar::set ( const char *  ,
int  ,
int  ,
int  ,
int   
)

◆ set() [42/62]

void IOPar::set ( const char *  ,
int64_t   
)

◆ set() [43/62]

void IOPar::set ( const char *  ,
int64_t  ,
int64_t   
)

◆ set() [44/62]

void IOPar::set ( const char *  ,
int64_t  ,
int64_t  ,
int64_t   
)

◆ set() [45/62]

void IOPar::set ( const char *  ,
int64_t  ,
int64_t  ,
int64_t  ,
int64_t   
)

◆ set() [46/62]

void IOPar::set ( const char *  ,
short   
)

◆ set() [47/62]

void IOPar::set ( const char *  ,
short  ,
short   
)

◆ set() [48/62]

void IOPar::set ( const char *  ,
short  ,
short  ,
short   
)

◆ set() [49/62]

void IOPar::set ( const char *  ,
short  ,
short  ,
short  ,
short   
)

◆ set() [50/62]

void IOPar::set ( const char *  ,
uint64_t   
)

◆ set() [51/62]

void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t   
)

◆ set() [52/62]

void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)

◆ set() [53/62]

void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)

◆ set() [54/62]

void IOPar::set ( const char *  ,
unsigned int   
)

◆ set() [55/62]

void IOPar::set ( const char *  ,
unsigned int  ,
unsigned int   
)

◆ set() [56/62]

void IOPar::set ( const char *  ,
unsigned int  ,
unsigned int  ,
unsigned int   
)

◆ set() [57/62]

void IOPar::set ( const char *  ,
unsigned int  ,
unsigned int  ,
unsigned int  ,
unsigned int   
)

◆ set() [58/62]

void IOPar::set ( const char *  ,
unsigned short   
)

◆ set() [59/62]

void IOPar::set ( const char *  ,
unsigned short  ,
unsigned short   
)

◆ set() [60/62]

void IOPar::set ( const char *  ,
unsigned short  ,
unsigned short  ,
unsigned short   
)

◆ set() [61/62]

void IOPar::set ( const char *  ,
unsigned short  ,
unsigned short  ,
unsigned short  ,
unsigned short   
)

◆ set() [62/62]

void IOPar::set ( const char *  ky,
const char *  val 
)

replaces when key already exists, otherwise adds

◆ setEmpty()

void IOPar::setEmpty ( )

remove all entries (doesn't clear name)

◆ setKey()

bool IOPar::setKey ( int  ,
const char *   
)

◆ setPatchVersion()

void IOPar::setPatchVersion ( int  )
protected

◆ setPtr()

void IOPar::setPtr ( const char *  ,
void *   
)

◆ setStdCreationEntries()

void IOPar::setStdCreationEntries ( )

◆ setToDateTime()

void IOPar::setToDateTime ( const char *  ky = nullptr)

◆ setToUser()

void IOPar::setToUser ( const char *  ky = nullptr)

◆ setValue()

void IOPar::setValue ( int  ,
const char *   
)

◆ setYN() [1/4]

void IOPar::setYN ( const char *  ,
bool   
)

◆ setYN() [2/4]

void IOPar::setYN ( const char *  ,
bool  ,
bool   
)

◆ setYN() [3/4]

void IOPar::setYN ( const char *  ,
bool  ,
bool  ,
bool   
)

◆ setYN() [4/4]

void IOPar::setYN ( const char *  ,
bool  ,
bool  ,
bool  ,
bool   
)

◆ size()

int IOPar::size ( ) const

◆ sKeyDumpPretty()

static const char* IOPar::sKeyDumpPretty ( )
inlinestatic

◆ sKeyHdr()

static const char* IOPar::sKeyHdr ( )
inlinestatic

◆ sKeySubHdr()

static const char* IOPar::sKeySubHdr ( )
inlinestatic

◆ subselect() [1/3]

IOPar* IOPar::subselect ( const char *  str) const

returns iopar with key that start with str.

◆ subselect() [2/3]

IOPar* IOPar::subselect ( const OD::String fs) const
inline

◆ subselect() [3/3]

IOPar* IOPar::subselect ( int  ) const

returns iopar with key that start with number.

◆ update()

void IOPar::update ( const char *  ky,
const char *  val 
)

removes if val is empty or null

◆ write() [1/2]

bool IOPar::write ( const char *  filename,
const char *  filetype 
) const

If filetype is set to null no ascstream header sKeyDumpPretty calls dumpPretty.

◆ write() [2/2]

bool IOPar::write ( od_ostream ,
const char *  filetyp 
) const

Member Data Documentation

◆ keys_

BufferStringSet& IOPar::keys_
protected

◆ majorversion_

int IOPar::majorversion_
protected

◆ minorversion_

int IOPar::minorversion_
protected

◆ vals_

BufferStringSet& IOPar::vals_
protected

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