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

Inheritance diagram for IOPar:

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 *, std::int16_t)

void	add (const char *, std::int16_t, std::int16_t)

void	add (const char *, std::int16_t, std::int16_t, std::int16_t)

void	add (const char *, std::int16_t, std::int16_t, std::int16_t, std::int16_t)

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

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

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

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

void	add (const char *, std::uint16_t)

void	add (const char *, std::uint16_t, std::uint16_t)

void	add (const char *, std::uint16_t, std::uint16_t, std::uint16_t)

void	add (const char *, std::uint16_t, std::uint16_t, std::uint16_t, std::uint16_t)

void	add (const char *, std::uint32_t)

void	add (const char *, std::uint32_t, std::uint32_t)

void	add (const char *, std::uint32_t, std::uint32_t, std::uint32_t)

void	add (const char *, std::uint32_t, std::uint32_t, std::uint32_t, std::uint32_t)

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

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

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

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

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, bool simple=true) const
	if simple, only save the top level objects More...

BufferString	find (const char *) const

BufferString	findKeyFor (const char *) const
	returns empty 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 *, 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

template<class T >
bool	get (const char *, IntegerID< T > &) const

template<class T >
bool	get (const char *, Interval< T > &) const

bool	get (const char *, MultiID &) const

bool	get (const char *, OD::Color &) const

bool	get (const char *, OD::GeomSystem &) const

template<class T >
bool	get (const char *, SamplingData< T > &) const

bool	get (const char *, SeparString &) const

bool	get (const char *, std::int16_t &) const

bool	get (const char *, std::int16_t &, std::int16_t &) const

bool	get (const char *, std::int16_t &, std::int16_t &, std::int16_t &) const

bool	get (const char *, std::int16_t &, std::int16_t &, std::int16_t &, std::int16_t &) const

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

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

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

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

bool	get (const char *, std::uint16_t &) const

bool	get (const char *, std::uint16_t &, std::uint16_t &) const

bool	get (const char *, std::uint16_t &, std::uint16_t &, std::uint16_t &) const

bool	get (const char *, std::uint16_t &, std::uint16_t &, std::uint16_t &, std::uint16_t &) const

bool	get (const char *, std::uint32_t &) const

bool	get (const char *, std::uint32_t &, std::uint32_t &) const

bool	get (const char *, std::uint32_t &, std::uint32_t &, std::uint32_t &) const

bool	get (const char *, std::uint32_t &, std::uint32_t &, std::uint32_t &, std::uint32_t &) const

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

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

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

bool	get (const char *, std::uint64_t &, std::uint64_t &, std::uint64_t &, std::uint64_t &) 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< MultiID > &) const

bool	get (const char *, TypeSet< Pos::GeomID > &) const

bool	get (const char *, TypeSet< std::int16_t > &) const

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

bool	get (const char *, TypeSet< std::uint16_t > &) const

bool	get (const char *, TypeSet< std::uint32_t > &) const

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

bool	get (const char *, uiString &) const

void	getFrom (ascistream &)

void	getFrom (const char *)

void	getKeys (BufferStringSet &) 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

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

bool	isEmpty () const

bool	isEqual (const IOPar &) 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...

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

IOPar &	operator= (const IOPar &)

bool	operator== (const IOPar &iop) const

BufferString	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)

bool	remove (int)=delete

bool	removeSubSelection (const char *str)
	removes with key that start with str. More...

bool	removeSubSelection (const OD::String &fs)

bool	removeSubSelection (int)
	removes with key that start with number. More...

bool	removeWithKey (const char *key)
	returns false if ky not found More...

bool	removeWithKeyPattern (const char *globexpression)

bool	replaceKey (const char oldkey, const char newkey)
	returns false if oldkey was not found More...

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 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 IntegerID< T > &)

template<class T >
void	set (const char *, const Interval< T > &)

void	set (const char *, const MultiID &)

void	set (const char *, const OD::Color &)

void	set (const char *, const OD::GeomSystem &)

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< MultiID > &)

void	set (const char *, const TypeSet< Pos::GeomID > &)

void	set (const char *, const TypeSet< std::int16_t > &)

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

void	set (const char *, const TypeSet< std::uint16_t > &)

void	set (const char *, const TypeSet< std::uint32_t > &)

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

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 *, std::int16_t)

void	set (const char *, std::int16_t, std::int16_t)

void	set (const char *, std::int16_t, std::int16_t, std::int16_t)

void	set (const char *, std::int16_t, std::int16_t, std::int16_t, std::int16_t)

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

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

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

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

void	set (const char *, std::uint16_t)

void	set (const char *, std::uint16_t, std::uint16_t)

void	set (const char *, std::uint16_t, std::uint16_t, std::uint16_t)

void	set (const char *, std::uint16_t, std::uint16_t, std::uint16_t, std::uint16_t)

void	set (const char *, std::uint32_t)

void	set (const char *, std::uint32_t, std::uint32_t)

void	set (const char *, std::uint32_t, std::uint32_t, std::uint32_t)

void	set (const char *, std::uint32_t, std::uint32_t, std::uint32_t, std::uint32_t)

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

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

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

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

void	set (const char ky, const char val)

void	setEmpty ()
	remove all entries (doesn't clear name) More...

void	setPtr (const char , void )

void	setStdCreationEntries ()

void	setToDateTime (const char *ky=nullptr)

void	setToUser (const char *ky=nullptr)

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

IOPar *	subselect (const char *str) const
	returns iopar with key that start with str. More...

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

IOPar *	subselect (int) const
	returns iopar with key that start with number. More...

void	update (const char ky, const char val)

bool	useJSON (const char *key, const OD::JSON::Array &)

bool	useJSON (const OD::JSON::Object &)

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 &)

const name_type &	name () const override

NamedObject &	operator= (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
bool	areSubParsIndexed () const

void	fillJSON (OD::JSON::Object &obj, const BufferStringSet &keys, const BufferStringSet &vals, const char *subkey, int &startidx) const

Protected Attributes
ODHashMap &	hashmap_

int	majorversion_

int	minorversion_

int	patchversion_

Protected Attributes inherited from NamedObject
BufferString	name_

Friends
class	IOParIterator

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 *	,
		std::int16_t
	)

◆ add() [14/34]

void IOPar::add	(	const char *	,
		std::int16_t	,
		std::int16_t
	)

◆ add() [15/34]

void IOPar::add	(	const char *	,
		std::int16_t	,
		std::int16_t	,
		std::int16_t
	)

◆ add() [16/34]

void IOPar::add	(	const char *	,
		std::int16_t	,
		std::int16_t	,
		std::int16_t	,
		std::int16_t
	)

◆ add() [17/34]

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

◆ add() [18/34]

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

◆ add() [19/34]

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

◆ add() [20/34]

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

◆ add() [21/34]

void IOPar::add	(	const char *	,
		std::uint16_t
	)

◆ add() [22/34]

void IOPar::add	(	const char *	,
		std::uint16_t	,
		std::uint16_t
	)

◆ add() [23/34]

void IOPar::add	(	const char *	,
		std::uint16_t	,
		std::uint16_t	,
		std::uint16_t
	)

◆ add() [24/34]

void IOPar::add	(	const char *	,
		std::uint16_t	,
		std::uint16_t	,
		std::uint16_t	,
		std::uint16_t
	)

◆ add() [25/34]

void IOPar::add	(	const char *	,
		std::uint32_t
	)

◆ add() [26/34]

void IOPar::add	(	const char *	,
		std::uint32_t	,
		std::uint32_t
	)

◆ add() [27/34]

void IOPar::add	(	const char *	,
		std::uint32_t	,
		std::uint32_t	,
		std::uint32_t
	)

◆ add() [28/34]

void IOPar::add	(	const char *	,
		std::uint32_t	,
		std::uint32_t	,
		std::uint32_t	,
		std::uint32_t
	)

◆ add() [29/34]

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

◆ add() [30/34]

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

◆ add() [31/34]

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

◆ add() [32/34]

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

◆ 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
	)

◆ areSubParsIndexed()

bool IOPar::areSubParsIndexed ( ) const

protected

◆ 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() [1/2]

void IOPar::fillJSON	(	OD::JSON::Object &	obj,
		bool	simple = `true`
	)		const

if simple, only save the top level objects

◆ fillJSON() [2/2]

void IOPar::fillJSON	(	OD::JSON::Object &	obj,
		const BufferStringSet &	keys,
		const BufferStringSet &	vals,
		const char *	subkey,
		int &	startidx
	)		const

protected

◆ find()

BufferString IOPar::find ( const char * ) const

◆ findKeyFor()

BufferString IOPar::findKeyFor ( const char * ) const

returns empty if value not found

◆ get() [1/62]

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

◆ get() [2/62]

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

◆ get() [3/62]

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

◆ get() [4/62]

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

◆ get() [5/62]

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

◆ get() [6/62]

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

◆ get() [7/62]

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

◆ get() [8/62]

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

◆ get() [9/62]

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

◆ get() [10/62]

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

◆ get() [11/62]

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

◆ get() [12/62]

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

◆ get() [13/62]

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

◆ get() [14/62]

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

◆ get() [15/62]

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

◆ get() [16/62]

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

◆ get() [17/62]

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

◆ get() [18/62]

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

◆ get() [19/62]

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

◆ get() [20/62]

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

◆ get() [21/62]

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

◆ get() [22/62]

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

◆ get() [23/62]

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

◆ get() [24/62]

template<class T >

bool IOPar::get	(	const char *	key,
		IntegerID< T > &	id
	)		const

◆ get() [25/62]

template<class T >

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

inline

◆ get() [26/62]

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

◆ get() [27/62]

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

◆ get() [28/62]

bool IOPar::get	(	const char *	,
		OD::GeomSystem &
	)		const

◆ get() [29/62]

template<class T >

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

inline

◆ get() [30/62]

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

◆ get() [31/62]

bool IOPar::get	(	const char *	,
		std::int16_t &
	)		const

◆ get() [32/62]

bool IOPar::get	(	const char *	,
		std::int16_t &	,
		std::int16_t &
	)		const

◆ get() [33/62]

bool IOPar::get	(	const char *	,
		std::int16_t &	,
		std::int16_t &	,
		std::int16_t &
	)		const

◆ get() [34/62]

bool IOPar::get	(	const char *	,
		std::int16_t &	,
		std::int16_t &	,
		std::int16_t &	,
		std::int16_t &
	)		const

◆ get() [35/62]

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

◆ get() [36/62]

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

◆ get() [37/62]

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

◆ get() [38/62]

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

◆ get() [39/62]

bool IOPar::get	(	const char *	,
		std::uint16_t &
	)		const

◆ get() [40/62]

bool IOPar::get	(	const char *	,
		std::uint16_t &	,
		std::uint16_t &
	)		const

◆ get() [41/62]

bool IOPar::get	(	const char *	,
		std::uint16_t &	,
		std::uint16_t &	,
		std::uint16_t &
	)		const

◆ get() [42/62]

bool IOPar::get	(	const char *	,
		std::uint16_t &	,
		std::uint16_t &	,
		std::uint16_t &	,
		std::uint16_t &
	)		const

◆ get() [43/62]

bool IOPar::get	(	const char *	,
		std::uint32_t &
	)		const

◆ get() [44/62]

bool IOPar::get	(	const char *	,
		std::uint32_t &	,
		std::uint32_t &
	)		const

◆ get() [45/62]

bool IOPar::get	(	const char *	,
		std::uint32_t &	,
		std::uint32_t &	,
		std::uint32_t &
	)		const

◆ get() [46/62]

bool IOPar::get	(	const char *	,
		std::uint32_t &	,
		std::uint32_t &	,
		std::uint32_t &	,
		std::uint32_t &
	)		const

◆ get() [47/62]

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

◆ get() [48/62]

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

◆ get() [49/62]

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

◆ get() [50/62]

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

◆ get() [51/62]

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

◆ get() [52/62]

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

◆ get() [53/62]

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

◆ get() [54/62]

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

◆ get() [55/62]

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

◆ get() [56/62]

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

◆ get() [57/62]

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

◆ get() [58/62]

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

◆ get() [59/62]

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

◆ get() [60/62]

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

◆ get() [61/62]

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

◆ get() [62/62]

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

◆ getFrom() [1/2]

void IOPar::getFrom ( ascistream & )

◆ getFrom() [2/2]

void IOPar::getFrom ( const char * )

◆ getKeys()

void IOPar::getKeys ( BufferStringSet & ) 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

◆ 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

◆ isEmpty()

bool IOPar::isEmpty ( ) const

◆ isEqual()

bool IOPar::isEqual ( const IOPar & ) const

◆ isFalse()

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

inline

◆ isPresent()

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

◆ 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.

◆ 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[]()

BufferString IOPar::operator[] ( const char * ky ) const

inline

◆ patchVersion()

int IOPar::patchVersion ( ) const

inline

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()

bool IOPar::remove ( int )

delete

◆ removeSubSelection() [1/3]

bool IOPar::removeSubSelection ( const char * str )

removes with key that start with str.

◆ removeSubSelection() [2/3]

bool IOPar::removeSubSelection ( const OD::String & fs )

inline

◆ removeSubSelection() [3/3]

bool IOPar::removeSubSelection ( int )

removes with key that start with number.

◆ removeWithKey()

bool IOPar::removeWithKey ( const char * key )

returns false if ky not found

◆ removeWithKeyPattern()

bool IOPar::removeWithKeyPattern ( const char * globexpression )

removes all entries with key matching this glob expression, return false if none found

◆ replaceKey()

bool IOPar::replaceKey	(	const char *	oldkey,
		const char *	newkey
	)

returns false if oldkey was not found

◆ set() [1/65]

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

◆ set() [2/65]

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

◆ set() [3/65]

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

◆ set() [4/65]

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

◆ set() [5/65]

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

◆ set() [6/65]

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

◆ set() [7/65]

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

◆ set() [8/65]

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

◆ set() [9/65]

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

◆ set() [10/65]

template<class T >

void IOPar::set	(	const char *	key,
		const IntegerID< T > &	id
	)

◆ set() [11/65]

template<class T >

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

inline

◆ set() [12/65]

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

◆ set() [13/65]

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

◆ set() [14/65]

void IOPar::set	(	const char *	,
		const OD::GeomSystem &
	)

◆ set() [15/65]

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

◆ set() [16/65]

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

◆ set() [17/65]

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

◆ set() [18/65]

template<class T >

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

inline

◆ set() [19/65]

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

◆ set() [20/65]

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

◆ set() [21/65]

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

◆ set() [22/65]

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

◆ set() [23/65]

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

◆ set() [24/65]

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

◆ set() [25/65]

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

◆ set() [26/65]

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

◆ set() [27/65]

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

◆ set() [28/65]

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

◆ set() [29/65]

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

◆ set() [30/65]

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

◆ set() [31/65]

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

◆ set() [32/65]

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

◆ set() [33/65]

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

◆ set() [34/65]

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

◆ set() [35/65]

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

◆ set() [36/65]

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

◆ set() [37/65]

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

◆ set() [38/65]

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

◆ set() [39/65]

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

◆ set() [40/65]

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

◆ set() [41/65]

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

◆ set() [42/65]

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

◆ set() [43/65]

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

◆ set() [44/65]

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

◆ set() [45/65]

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

◆ set() [46/65]

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

◆ set() [47/65]

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

◆ set() [48/65]

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

◆ set() [49/65]

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

◆ set() [50/65]

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

◆ set() [51/65]

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

◆ set() [52/65]

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

◆ set() [53/65]

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

◆ set() [54/65]

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

◆ set() [55/65]

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

◆ set() [56/65]

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

◆ set() [57/65]

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

◆ set() [58/65]

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

◆ set() [59/65]

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

◆ set() [60/65]

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

◆ set() [61/65]

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

◆ set() [62/65]

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

◆ set() [63/65]

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

◆ set() [64/65]

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

◆ set() [65/65]

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)

◆ 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 )

◆ 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

◆ useJSON() [1/2]

bool IOPar::useJSON	(	const char *	key,
		const OD::JSON::Array &
	)

◆ useJSON() [2/2]

bool IOPar::useJSON ( const OD::JSON::Object & )

◆ 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

Friends And Related Function Documentation

◆ IOParIterator

friend class IOParIterator

friend

Member Data Documentation

◆ hashmap_

ODHashMap& IOPar::hashmap_

protected

◆ majorversion_

int IOPar::majorversion_

protected

◆ minorversion_

int IOPar::minorversion_

protected

◆ patchversion_

int IOPar::patchversion_

protected

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IOPar() [1/3]

◆ IOPar() [2/3]

◆ IOPar() [3/3]

◆ ~IOPar()

Member Function Documentation

◆ add() [1/34]

◆ add() [2/34]

◆ add() [3/34]

◆ add() [4/34]

◆ add() [5/34]

◆ add() [6/34]

◆ add() [7/34]

◆ add() [8/34]

◆ add() [9/34]

◆ add() [10/34]

◆ add() [11/34]

◆ add() [12/34]

◆ add() [13/34]

◆ add() [14/34]

◆ add() [15/34]

◆ add() [16/34]

◆ add() [17/34]

◆ add() [18/34]

◆ add() [19/34]

◆ add() [20/34]

◆ add() [21/34]

◆ add() [22/34]

◆ add() [23/34]

◆ add() [24/34]

◆ add() [25/34]

◆ add() [26/34]

◆ add() [27/34]

◆ add() [28/34]

◆ add() [29/34]

◆ add() [30/34]

◆ add() [31/34]

◆ add() [32/34]

◆ add() [33/34]

◆ add() [34/34]

◆ addFrom()

◆ addVal()

◆ addYN() [1/4]

◆ addYN() [2/4]

◆ addYN() [3/4]

◆ addYN() [4/4]

◆ areSubParsIndexed()

◆ compKey() [1/3]

◆ compKey() [2/3]

◆ compKey() [3/3]

◆ dumpPretty() [1/2]

◆ dumpPretty() [2/2]

◆ fillJSON() [1/2]

◆ fillJSON() [2/2]

◆ find()

◆ findKeyFor()

◆ get() [1/62]

◆ get() [2/62]

◆ get() [3/62]

◆ get() [4/62]

◆ get() [5/62]

◆ get() [6/62]

◆ get() [7/62]

◆ get() [8/62]

◆ get() [9/62]

◆ get() [10/62]

◆ get() [11/62]

◆ get() [12/62]

◆ get() [13/62]

◆ get() [14/62]

◆ get() [15/62]

◆ get() [16/62]

◆ get() [17/62]