Settings class holds the user settings. It is an IOPar. More...

Inheritance diagram for Settings:

Public Member Functions
void	remove ()
	Only specialist use i.e. on program closing. More...

bool	reRead ()

bool	write (bool read_before=true) const

Public Member Functions inherited from IOPar
	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

IOPar &	operator= (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

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	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_type &	name () const

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 Settings &	common ()

static Settings &	fetch (const char *settings_name=0)

static Settings *	fetchExternal (const char settings_name, const char dtect_user, const char *usr_settings_dir)
	for sysadm purposes More...

Static Public Member Functions inherited from IOPar
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
	Settings (const char *fnm)

	~Settings ()

bool	doRead (bool)

Protected Member Functions inherited from IOPar
void	setPatchVersion (int)

Static Protected Member Functions
static Settings *	doFetch (const char , const char , const char *, bool)

Protected Attributes
BufferString	fname_

Protected Attributes inherited from IOPar
BufferStringSet &	keys_

int	majorversion_

int	minorversion_

BufferStringSet &	vals_

Protected Attributes inherited from NamedObject
BufferString	name_

Static Private Member Functions
static void	manageSettings (Settings *)

Friends
class	SettingsManager

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Detailed Description

Settings class holds the user settings. It is an IOPar.

The common() settings are basic, global user settings. For a specific subject or from a plugin, just call fetch( yourkey ), and a new Settings instance will be made if necessary. You can provide defaults in a file yourkeySettings which must be located in OD's data subdirectory.

The data is stored in ~/.od/settings (common) and ~/.od/settings_yourkey for other keys. If $DTECT_USER is set, '.$DTECT_USER' is appended to the filename.

<>

Constructor & Destructor Documentation

◆ Settings()

Settings::Settings ( const char * fnm )

inlineprotected

◆ ~Settings()

Settings::~Settings ( )

inlineprotected

Member Function Documentation

◆ common()

static Settings& Settings::common ( )

inlinestatic

◆ doFetch()

static Settings* Settings::doFetch	(	const char *	,
		const char *	,
		const char *	,
		bool
	)

staticprotected

◆ doRead()

bool Settings::doRead ( bool )

protected

◆ fetch()

static Settings& Settings::fetch ( const char * settings_name = 0 )

static

◆ fetchExternal()

static Settings* Settings::fetchExternal	(	const char *	settings_name,
		const char *	dtect_user,
		const char *	usr_settings_dir
	)

static

for sysadm purposes

◆ manageSettings()

static void Settings::manageSettings ( Settings * )

staticprivate

◆ remove()

void Settings::remove ( )

inline

Only specialist use i.e. on program closing.

◆ reRead()

bool Settings::reRead ( )

inline

Needed in case you know that the file has been changed by user or external routine. It's not likely that you'll need this.

◆ write()

bool Settings::write ( bool read_before = true ) const

read_before should be true: this is the protection against another update being screwed by this one

Friends And Related Function Documentation

◆ SettingsManager

friend class SettingsManager

friend

Member Data Documentation

◆ fname_

BufferString Settings::fname_