OpendTect  7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Private Member Functions | Friends | List of all members
Settings Class Reference
Basic

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

Inheritance diagram for Settings:
[legend]

Public Member Functions

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 *, 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 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 bool settsFileExist (const char *settings_name)
 
- 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
bool areSubParsIndexed () const
 
void fillJSON (OD::JSON::Object &obj, const BufferStringSet &keys, const BufferStringSet &vals, const char *subkey, int &startidx) const
 

Static Protected Member Functions

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

Protected Attributes

BufferString fname_
 
- Protected Attributes inherited from IOPar
ODHashMap & hashmap_
 
int majorversion_
 
int minorversion_
 
int patchversion_
 
- 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

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

◆ settsFileExist()

static bool Settings::settsFileExist ( const char *  settings_name)
static

◆ 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_
protected

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