Public Member Functions | Static Public Member Functions | Protected Attributes

IOPar Class Reference

Inheritance diagram for IOPar:
NamedObject CallBacker Settings

List of all members.

Public Member Functions

 IOPar (const char *nm=0)
 empty
 IOPar (ascistream &)
 IOPar (const IOPar &)
 ~IOPar ()
IOParoperator= (const IOPar &)
bool operator== (const IOPar &iop) const
bool operator!= (const IOPar &iop) const
int size () const
bool isEmpty () const
bool isEqual (const IOPar &, bool need_same_order=false) const
int indexOf (const char *key) const
const char * getKey (int) const
const char * getValue (int) const
bool setKey (int, const char *)
void setValue (int, const char *)
void remove (int)
void remove (const char *key)
bool hasKey (const char *s) const
const char * findKeyFor (const char *, int nr=0) const
 returns null if value not found
void removeWithKey (const char *globexpression)
void setEmpty ()
 remove all entries (doesn't clear name)
void merge (const IOPar &)
 merge entries using the set() command
IOParsubselect (const char *) const
 returns iopar with key that start with <str>.
IOParsubselect (int) const
 returns iopar with key that start with number.
void removeSubSelection (const char *)
 removes with key that start with <str>.
void removeSubSelection (int)
 removes with key that start with number.
void mergeComp (const IOPar &, const char *)
 merge entries, where IOPar's entries get a prefix
FixedString find (const char *) const
 returns null if not found
FixedString operator[] (const char *) const
 returns empty string if not found
bool get (const char *, int &) const
bool get (const char *, int &, int &) const
bool get (const char *, int &, int &, int &) const
bool get (const char *, int &, int &, int &, int &) 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 *, 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
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 *, 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 *, 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 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 isTrue (const char *key) const
bool isFalse (const char *key) const
bool get (const char *, int &, int &, float &) const
bool get (const char *, TypeSet< int > &) const
bool get (const char *, TypeSet< unsigned int > &) const
bool get (const char *, TypeSet< int64_t > &) const
bool get (const char *, TypeSet< uint64_t > &) const
bool get (const char *, TypeSet< double > &) const
bool get (const char *, TypeSet< float > &) const
bool get (const char *, BinID &) const
bool get (const char *, Coord &) const
bool get (const char *, Coord3 &) const
bool get (const char *, MultiID &) const
bool get (const char *, Color &) const
bool get (const char *, SeparString &) const
bool get (const char *, BufferString &) const
bool get (const char *, BufferString &, BufferString &) const
bool get (const char *, BufferStringSet &) const
template<class T >
bool get (const char *, Interval< T > &) const
template<class T >
bool get (const char *, SamplingData< T > &) const
bool getPtr (const char *, void *&) const
bool getScaled (const char *, float &, float applied_scale, bool set_to_undef_if_not_found) const
bool getScaled (const char *, float &, float &, float, bool) const
bool getScaled (const char *, float &, float &, float &, float, bool) const
bool getScaled (const char *, float &, float &, float &, float &, float, bool) const
bool getScaled (const char *, double &, double applied_scale, bool set_to_undef_if_not_found) const
bool getScaled (const char *, double &, double &, double, bool) const
bool getScaled (const char *, double &, double &, double &, double, bool) const
bool getScaled (const char *, double &, double &, double &, double &, double, bool) const
void set (const char *, const char *)
void add (const char *, const char *)
void set (const char *, int)
void set (const char *, int, int)
void set (const char *, int, int, int)
void set (const char *, int, int, int, int)
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 *, 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 *, 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 *, 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 *, double)
void set (const char *, double, double)
void set (const char *, double, double, double)
void set (const char *, double, double, double, double)
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 *, 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 *, 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 *, 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 *, 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 *, double)
void add (const char *, double, double)
void add (const char *, double, double, double)
void add (const char *, double, double, double, double)
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)
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 set (const char *, int, int, float)
void setPtr (const char *, void *)
void set (const char *, const char *, const char *)
void set (const char *, const BinID &)
void set (const char *, const Coord &)
void set (const char *, const Coord3 &)
void set (const char *, const MultiID &)
void set (const char *, const Color &)
void set (const char *, const SeparString &)
void set (const char *, const FixedString &)
void set (const char *, const BufferString &)
void set (const char *, const BufferString &, const BufferString &)
void set (const char *, const BufferStringSet &)
template<class T >
void set (const char *, const Interval< T > &)
template<class T >
void set (const char *, const SamplingData< T > &)
void set (const char *, const TypeSet< int > &)
void set (const char *, const TypeSet< unsigned int > &)
void set (const char *, const TypeSet< int64_t > &)
void set (const char *, const TypeSet< uint64_t > &)
void set (const char *, const TypeSet< double > &)
void set (const char *, const TypeSet< float > &)
void getFrom (const char *)
void getParsFrom (const char *)
void putTo (BufferString &) const
void putParsTo (BufferString &) const
void getFrom (ascistream &)
void putTo (ascostream &) const
bool read (const char *filename, const char *filetype, bool chktype=false)
bool read (std::istream &, const char *filetype, bool chktype=false)
bool write (const char *filename, const char *filetype) const
bool write (std::ostream &, const char *filetyp) const
void dumpPretty (std::ostream &) const

Static Public Member Functions

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

Protected Attributes

BufferStringSetkeys_
BufferStringSetvals_

Constructor & Destructor Documentation

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

empty

IOPar::IOPar ( ascistream  ) 
IOPar::IOPar ( const IOPar  ) 
IOPar::~IOPar (  ) 

Member Function Documentation

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

Add does not check for duplicate keys

void IOPar::add ( const char *  ,
float  ,
float   
)
void IOPar::add ( const char *  ,
float  ,
float  ,
float   
)
void IOPar::add ( const char *  ,
float  ,
float  ,
float  ,
float   
)
void IOPar::add ( const char *  ,
double   
)
void IOPar::add ( const char *  ,
double  ,
double   
)
void IOPar::add ( const char *  ,
double  ,
double  ,
double   
)
void IOPar::add ( const char *  ,
double  ,
double  ,
double  ,
double   
)
void IOPar::add ( const char *  ,
int   
)
void IOPar::add ( const char *  ,
int  ,
int   
)
void IOPar::add ( const char *  ,
int  ,
int  ,
int   
)
void IOPar::add ( const char *  ,
int  ,
int  ,
int  ,
int   
)
void IOPar::add ( const char *  ,
unsigned  int 
)
void IOPar::add ( const char *  ,
unsigned  int,
unsigned  int 
)
void IOPar::add ( const char *  ,
unsigned  int,
unsigned  int,
unsigned  int 
)
void IOPar::add ( const char *  ,
unsigned  int,
unsigned  int,
unsigned  int,
unsigned  int 
)
void IOPar::add ( const char *  ,
int64_t   
)
void IOPar::add ( const char *  ,
int64_t  ,
int64_t   
)
void IOPar::add ( const char *  ,
int64_t  ,
int64_t  ,
int64_t   
)
void IOPar::add ( const char *  ,
int64_t  ,
int64_t  ,
int64_t  ,
int64_t   
)
void IOPar::add ( const char *  ,
uint64_t   
)
void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t   
)
void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)
void IOPar::add ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)
void IOPar::add ( const char *  ,
float   
)
void IOPar::addYN ( const char *  ,
bool   
)
void IOPar::addYN ( const char *  ,
bool  ,
bool   
)
void IOPar::addYN ( const char *  ,
bool  ,
bool  ,
bool   
)
void IOPar::addYN ( const char *  ,
bool  ,
bool  ,
bool  ,
bool   
)
static const char* IOPar::compKey ( const char *  ,
const char *   
) [static]

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

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

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

void IOPar::dumpPretty ( std::ostream &   )  const
FixedString IOPar::find ( const char *   )  const

returns null if not found

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

returns null if value not found

bool IOPar::get ( const char *  ,
TypeSet< float > &   
) const
bool IOPar::get ( const char *  ,
BinID  
) const
bool IOPar::get ( const char *  ,
unsigned int &   
) const
bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &   
) const
bool IOPar::get ( const char *  ,
Coord  
) const
bool IOPar::get ( const char *  ,
Coord3  
) const
bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
) const
bool IOPar::get ( const char *  ,
MultiID  
) const
bool IOPar::get ( const char *  ,
Color  
) const
bool IOPar::get ( const char *  ,
SeparString  
) const
bool IOPar::get ( const char *  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
) const
bool IOPar::get ( const char *  ,
BufferString  
) const
bool IOPar::get ( const char *  ,
int64_t &   
) const
bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &   
) const
bool IOPar::get ( const char *  ,
BufferString ,
BufferString  
) const
bool IOPar::get ( const char *  ,
BufferStringSet  
) const
template<class T >
bool IOPar::get ( const char *  k,
Interval< T > &  i 
) const [inline]
template<class T >
bool IOPar::get ( const char *  k,
SamplingData< T > &  sd 
) const [inline]
bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &  ,
int64_t &   
) const
bool IOPar::get ( const char *  ,
int64_t &  ,
int64_t &  ,
int64_t &  ,
int64_t &   
) const
bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &   
) const
bool IOPar::get ( const char *  ,
uint64_t &   
) const
bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &   
) const
bool IOPar::get ( const char *  ,
uint64_t &  ,
uint64_t &  ,
uint64_t &   
) const
bool IOPar::get ( const char *  ,
float &   
) const
bool IOPar::get ( const char *  ,
float &  ,
float &   
) const
bool IOPar::get ( const char *  ,
float &  ,
float &  ,
float &   
) const
bool IOPar::get ( const char *  ,
float &  ,
float &  ,
float &  ,
float &   
) const
bool IOPar::get ( const char *  ,
double &  ,
double &   
) const
bool IOPar::get ( const char *  ,
double &  ,
double &  ,
double &   
) const
bool IOPar::get ( const char *  ,
double &  ,
double &  ,
double &  ,
double &   
) const
bool IOPar::get ( const char *  ,
double &   
) const
bool IOPar::get ( const char *  ,
int &  ,
int &   
) const
bool IOPar::get ( const char *  ,
int &   
) const
bool IOPar::get ( const char *  ,
int &  ,
int &  ,
float &   
) const
bool IOPar::get ( const char *  ,
TypeSet< int > &   
) const
bool IOPar::get ( const char *  ,
int &  ,
int &  ,
int &   
) const
bool IOPar::get ( const char *  ,
TypeSet< unsigned int > &   
) const
bool IOPar::get ( const char *  ,
TypeSet< int64_t > &   
) const
bool IOPar::get ( const char *  ,
TypeSet< uint64_t > &   
) const
bool IOPar::get ( const char *  ,
int &  ,
int &  ,
int &  ,
int &   
) const
bool IOPar::get ( const char *  ,
TypeSet< double > &   
) const
void IOPar::getFrom ( const char *   ) 
void IOPar::getFrom ( ascistream  ) 
const char* IOPar::getKey ( int   )  const
void IOPar::getParsFrom ( const char *   ) 
bool IOPar::getPtr ( const char *  ,
void *&   
) const
bool IOPar::getScaled ( const char *  ,
float &  ,
float  applied_scale,
bool  set_to_undef_if_not_found 
) const
bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float  ,
bool   
) const
bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float &  ,
float  ,
bool   
) const
bool IOPar::getScaled ( const char *  ,
float &  ,
float &  ,
float &  ,
float &  ,
float  ,
bool   
) const
bool IOPar::getScaled ( const char *  ,
double &  ,
double  applied_scale,
bool  set_to_undef_if_not_found 
) const
bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double &  ,
double  ,
bool   
) const
bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double &  ,
double &  ,
double  ,
bool   
) const
bool IOPar::getScaled ( const char *  ,
double &  ,
double &  ,
double  ,
bool   
) const
const char* IOPar::getValue ( int   )  const
bool IOPar::getYN ( const char *  ,
bool &  ,
bool &   
) const
bool IOPar::getYN ( const char *  ,
bool &   
) const
bool IOPar::getYN ( const char *  ,
bool &  ,
bool &  ,
bool &   
) const
bool IOPar::getYN ( const char *  ,
bool &  ,
bool &  ,
bool &  ,
bool &   
) const
bool IOPar::hasKey ( const char *  s  )  const [inline]
int IOPar::indexOf ( const char *  key  )  const
bool IOPar::isEmpty (  )  const [inline]
bool IOPar::isEqual ( const IOPar ,
bool  need_same_order = false 
) const
bool IOPar::isFalse ( const char *  key  )  const [inline]
bool IOPar::isTrue ( const char *  key  )  const [inline]
void IOPar::merge ( const IOPar  ) 

merge entries using the set() command

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

merge entries, where IOPar's entries get a prefix

bool IOPar::operator!= ( const IOPar iop  )  const [inline]
IOPar& IOPar::operator= ( const IOPar  ) 
bool IOPar::operator== ( const IOPar iop  )  const [inline]
FixedString IOPar::operator[] ( const char *   )  const

returns empty string if not found

void IOPar::putParsTo ( BufferString  )  const
void IOPar::putTo ( BufferString  )  const
void IOPar::putTo ( ascostream  )  const
bool IOPar::read ( std::istream &  ,
const char *  filetype,
bool  chktype = false 
)
bool IOPar::read ( const char *  filename,
const char *  filetype,
bool  chktype = false 
)

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

void IOPar::remove ( int   ) 
void IOPar::remove ( const char *  key  ) 
void IOPar::removeSubSelection ( const char *   ) 

removes with key that start with <str>.

void IOPar::removeSubSelection ( int   ) 

removes with key that start with number.

void IOPar::removeWithKey ( const char *  globexpression  ) 

removes all entries with key matching this glob expression

void IOPar::set ( const char *  ,
double  ,
double   
)
void IOPar::set ( const char *  ,
double  ,
double  ,
double  ,
double   
)
void IOPar::set ( const char *  ,
double  ,
double  ,
double   
)
void IOPar::set ( const char *  ,
float  ,
float   
)
void IOPar::set ( const char *  ,
double   
)
void IOPar::set ( const char *  ,
const FixedString  
)
void IOPar::set ( const char *  ,
int   
)
void IOPar::set ( const char *  ,
float   
)
void IOPar::set ( const char *  ,
int  ,
int  ,
int  ,
int   
)
void IOPar::set ( const char *  ,
const char *  ,
const char *   
)
void IOPar::set ( const char *  ,
int  ,
int  ,
float   
)
void IOPar::set ( const char *  ,
const BufferString ,
const BufferString  
)
void IOPar::set ( const char *  ,
int64_t  ,
int64_t   
)
void IOPar::set ( const char *  ,
const BufferString  
)
void IOPar::set ( const char *  ,
const TypeSet< float > &   
)
void IOPar::set ( const char *  ,
const TypeSet< uint64_t > &   
)
void IOPar::set ( const char *  ,
unsigned  int,
unsigned  int 
)
void IOPar::set ( const char *  ,
const TypeSet< double > &   
)
void IOPar::set ( const char *  ,
int64_t  ,
int64_t  ,
int64_t   
)
template<class T >
void IOPar::set ( const char *  k,
const SamplingData< T > &  sd 
) [inline]
void IOPar::set ( const char *  ,
unsigned  int,
unsigned  int,
unsigned  int 
)
void IOPar::set ( const char *  ,
const Color  
)
void IOPar::set ( const char *  ,
unsigned  int 
)
void IOPar::set ( const char *  ,
int64_t  ,
int64_t  ,
int64_t  ,
int64_t   
)
void IOPar::set ( const char *  ,
uint64_t   
)
void IOPar::set ( const char *  ,
int64_t   
)
void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)
void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t  ,
uint64_t   
)
void IOPar::set ( const char *  ,
const TypeSet< unsigned int > &   
)
void IOPar::set ( const char *  ,
int  ,
int   
)
void IOPar::set ( const char *  ,
int  ,
int  ,
int   
)
void IOPar::set ( const char *  ,
float  ,
float  ,
float  ,
float   
)
void IOPar::set ( const char *  ,
float  ,
float  ,
float   
)
void IOPar::set ( const char *  ,
const BufferStringSet  
)
void IOPar::set ( const char *  ,
uint64_t  ,
uint64_t   
)
void IOPar::set ( const char *  ,
unsigned  int,
unsigned  int,
unsigned  int,
unsigned  int 
)
template<class T >
void IOPar::set ( const char *  k,
const Interval< T > &  i 
) [inline]
void IOPar::set ( const char *  ,
const BinID  
)
void IOPar::set ( const char *  ,
const SeparString  
)
void IOPar::set ( const char *  ,
const TypeSet< int > &   
)
void IOPar::set ( const char *  ,
const Coord  
)
void IOPar::set ( const char *  ,
const char *   
)

Set replaces when key already exists

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

remove all entries (doesn't clear name)

bool IOPar::setKey ( int  ,
const char *   
)
void IOPar::setPtr ( const char *  ,
void *   
)
void IOPar::setValue ( int  ,
const char *   
)
void IOPar::setYN ( const char *  ,
bool  ,
bool  ,
bool  ,
bool   
)
void IOPar::setYN ( const char *  ,
bool  ,
bool  ,
bool   
)
void IOPar::setYN ( const char *  ,
bool   
)
void IOPar::setYN ( const char *  ,
bool  ,
bool   
)
int IOPar::size (  )  const
static const char* IOPar::sKeyDumpPretty (  )  [inline, static]
static const char* IOPar::sKeyHdr (  )  [inline, static]
static const char* IOPar::sKeySubHdr (  )  [inline, static]
IOPar* IOPar::subselect ( int   )  const

returns iopar with key that start with number.

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

returns iopar with key that start with <str>.

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

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

bool IOPar::write ( std::ostream &  ,
const char *  filetyp 
) const

Member Data Documentation