OpendTect-6_4  6.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Attrib::DescSet Class Reference

Set of attribute descriptions. More...

Inheritance diagram for Attrib::DescSet:
[legend]

Public Member Functions

DescID ensureDefStoredPresent () const
 
- Public Member Functions inherited from CallBacker
 CallBacker ()
 
 CallBacker (const CallBacker &)
 
virtual ~CallBacker ()
 
bool attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
 
bool attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
 
void detachCB (NotifierAccess &, const CallBack &)
 
void detachCB (NotifierAccess *notif, const CallBack &cb)
 
bool isNotifierAttached (NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 

Static Public Member Functions

static uiString sFactoryEntryNotFound (const char *attrnm)
 

Protected Member Functions

DescID getFreeID () const
 
- Protected Member Functions inherited from CallBacker
void detachAllNotifiers ()
 Call from the destructor of your inherited object. More...
 

Protected Attributes

ObjectSet< Descdescs_
 
TypeSet< DescIDids_
 
bool is2d_
 
bool storedattronly_
 
bool couldbeanydim_
 
uiString errmsg_
 
BufferString defidstr_
 
DescID defattribid_
 

Private Member Functions

 ~DescSet ()
 
DescSetoperator= (const DescSet &)
 
bool isEmpty () const
 
int size () const
 
int indexOf (const char *nm, bool usrref=true) const
 
bool isPresent (const char *nm, bool usr=true) const
 
DescSetoptimizeClone (const DescID &targetid) const
 
DescSetoptimizeClone (const TypeSet< DescID > &) const
 
DescSetoptimizeClone (const BufferStringSet &) const
 
void updateInputs ()
 
DescID addDesc (Desc *, DescID newid=DescID())
 
DescID insertDesc (Desc *, int, DescID newid=DescID())
 
void createAndAddMultOutDescs (const DescID &, const TypeSet< int > &, const BufferStringSet &, TypeSet< DescID > &)
 
Descoperator[] (int idx)
 
const Descoperator[] (int idx) const
 
int nrDescs (bool inclstored, bool inclhidden) const
 use size() if you just want all More...
 
Descdesc (int idx)
 
const Descdesc (int idx) const
 
DescgetDesc (const DescID &id)
 
const DescgetDesc (const DescID &id) const
 
DescID getID (const Desc &) const
 
DescID getID (int) const
 
DescID getID (const char *ref, bool isusrref, bool mustbestored=false, bool usestorinfo=false) const
 
void getIds (TypeSet< DescID > &) const
 
void getStoredIds (TypeSet< DescID > &) const
 
DescID getStoredID (const MultiID &, int selout=-1, bool create=true, bool blindcomp=false, const char *blindcompnm=0)
 
DescgetFirstStored (bool usesteering=true) const
 
MultiID getStoredKey (const DescID &) const
 
void getStoredNames (BufferStringSet &) const
 
void getAttribNames (BufferStringSet &, bool inclhidden) const
 
void removeDesc (const DescID &)
 
void moveDescUpDown (const DescID &, bool)
 
void sortDescSet ()
 
void removeAll (bool kpdefault)
 
int removeUnused (bool removestored=false, bool kpdefault=true)
 
bool isAttribUsed (const DescID &, BufferString &) const
 
bool isAttribUsed (const DescID &) const
 
void cleanUpDescsMissingInputs ()
 
bool createSteeringDesc (const IOPar &, BufferString, ObjectSet< Desc > &, int &id, uiStringSet *errmsgs=0)
 
DesccreateDesc (const BufferString &, const IOPar &, const BufferString &)
 
DescID createStoredDesc (const MultiID &, int selout, const BufferString &compnm)
 
bool setAllInputDescs (int, const IOPar &, uiStringSet *)
 
void handleStorageOldFormat (IOPar &)
 
void handleOldAttributes (BufferString &, IOPar &, BufferString &, int) const
 
void handleOldMathExpression (IOPar &, BufferString &, int) const
 
void handleReferenceInput (Desc *)
 
void fillInAttribColRefs (BufferStringSet &) const
 
void fillInUIInputList (BufferStringSet &) const
 
DescgetDescFromUIListEntry (FileMultiString)
 will create an empty DataPointSet More...
 
DataPointSetcreateDataPointSet (Attrib::DescSetup, bool withstored=true) const
 
void fillInSelSpecs (Attrib::DescSetup, TypeSet< Attrib::SelSpec > &) const
 
void setContainStoredDescOnly (bool yn)
 
bool containsStoredDescOnly () const
 
void setCouldBeUsedInAnyDimension (bool yn)
 
bool couldBeUsedInAnyDimension () const
 
bool hasStoredInMem () const
 
bool exportToDot (const char *nm, const char *fnm) const
 
bool is2D () const
 
uiString errMsg () const
 
void fillPar (IOPar &) const
 
bool usePar (const IOPar &, uiStringSet *errmsgs=0)
 
bool useOldSteeringPar (IOPar &, ObjectSet< Desc > &, uiStringSet *)
 
DescgtDesc (const DescID &) const
 

Static Private Member Functions

static DesccreateDesc (const BufferString &, const IOPar &, const BufferString &, uiStringSet *)
 
static const char * highestIDStr ()
 
static const char * definitionStr ()
 
static const char * userRefStr ()
 
static const char * inputPrefixStr ()
 
static const char * hiddenStr ()
 
static const char * indexStr ()
 
static BufferString storedIDErrStr ()
 

Private Attributes

CNotifier< DescSet, DescIDdescToBeRemoved
 

Detailed Description

Set of attribute descriptions.

Constructor & Destructor Documentation

Attrib::DescSet::~DescSet ( )
inlineprivate

Member Function Documentation

DescID Attrib::DescSet::addDesc ( Desc ,
DescID  newid = DescID() 
)
private

returns id of the attrib

void Attrib::DescSet::cleanUpDescsMissingInputs ( )
private
bool Attrib::DescSet::containsStoredDescOnly ( ) const
inlineprivate
bool Attrib::DescSet::couldBeUsedInAnyDimension ( ) const
inlineprivate
void Attrib::DescSet::createAndAddMultOutDescs ( const DescID ,
const TypeSet< int > &  ,
const BufferStringSet ,
TypeSet< DescID > &   
)
private

Make sure all descs needed to compute attributes with multiple outputs are created and added

DataPointSet* Attrib::DescSet::createDataPointSet ( Attrib::DescSetup  ,
bool  withstored = true 
) const
private
static Desc* Attrib::DescSet::createDesc ( const BufferString ,
const IOPar ,
const BufferString ,
uiStringSet  
)
staticprivate
Desc* Attrib::DescSet::createDesc ( const BufferString ,
const IOPar ,
const BufferString  
)
private
bool Attrib::DescSet::createSteeringDesc ( const IOPar ,
BufferString  ,
ObjectSet< Desc > &  ,
int &  id,
uiStringSet errmsgs = 0 
)
private
DescID Attrib::DescSet::createStoredDesc ( const MultiID ,
int  selout,
const BufferString compnm 
)
private
static const char* Attrib::DescSet::definitionStr ( )
inlinestaticprivate
Desc* Attrib::DescSet::desc ( int  idx)
inlineprivate
const Desc* Attrib::DescSet::desc ( int  idx) const
inlineprivate
DescID Attrib::DescSet::ensureDefStoredPresent ( ) const
uiString Attrib::DescSet::errMsg ( ) const
private
bool Attrib::DescSet::exportToDot ( const char *  nm,
const char *  fnm 
) const
private
void Attrib::DescSet::fillInAttribColRefs ( BufferStringSet ) const
private

will prepare strings for each desc, format : Attrib,[stored], [{prestack}]

void Attrib::DescSet::fillInSelSpecs ( Attrib::DescSetup  ,
TypeSet< Attrib::SelSpec > &   
) const
private
void Attrib::DescSet::fillInUIInputList ( BufferStringSet ) const
private

Counterpart: will decode the UI string and return the corresponding Desc*

void Attrib::DescSet::fillPar ( IOPar ) const
private
void Attrib::DescSet::getAttribNames ( BufferStringSet ,
bool  inclhidden 
) const
private
Desc* Attrib::DescSet::getDesc ( const DescID id)
inlineprivate
const Desc* Attrib::DescSet::getDesc ( const DescID id) const
inlineprivate
Desc* Attrib::DescSet::getDescFromUIListEntry ( FileMultiString  )
private

will create an empty DataPointSet

Desc* Attrib::DescSet::getFirstStored ( bool  usesteering = true) const
private
DescID Attrib::DescSet::getFreeID ( ) const
protected
DescID Attrib::DescSet::getID ( const Desc ) const
private
DescID Attrib::DescSet::getID ( int  ) const
private
DescID Attrib::DescSet::getID ( const char *  ref,
bool  isusrref,
bool  mustbestored = false,
bool  usestorinfo = false 
) const
private
void Attrib::DescSet::getIds ( TypeSet< DescID > &  ) const
private
DescID Attrib::DescSet::getStoredID ( const MultiID ,
int  selout = -1,
bool  create = true,
bool  blindcomp = false,
const char *  blindcompnm = 0 
)
private
void Attrib::DescSet::getStoredIds ( TypeSet< DescID > &  ) const
private
MultiID Attrib::DescSet::getStoredKey ( const DescID ) const
private
void Attrib::DescSet::getStoredNames ( BufferStringSet ) const
private
Desc* Attrib::DescSet::gtDesc ( const DescID ) const
private
void Attrib::DescSet::handleOldAttributes ( BufferString ,
IOPar ,
BufferString ,
int   
) const
private
void Attrib::DescSet::handleOldMathExpression ( IOPar ,
BufferString ,
int   
) const
private
void Attrib::DescSet::handleReferenceInput ( Desc )
private

will prepare strings for each desc, format : DescID`definition string

void Attrib::DescSet::handleStorageOldFormat ( IOPar )
private
bool Attrib::DescSet::hasStoredInMem ( ) const
private
static const char* Attrib::DescSet::hiddenStr ( )
inlinestaticprivate
static const char* Attrib::DescSet::highestIDStr ( )
inlinestaticprivate
int Attrib::DescSet::indexOf ( const char *  nm,
bool  usrref = true 
) const
private
static const char* Attrib::DescSet::indexStr ( )
inlinestaticprivate
static const char* Attrib::DescSet::inputPrefixStr ( )
inlinestaticprivate
DescID Attrib::DescSet::insertDesc ( Desc ,
int  ,
DescID  newid = DescID() 
)
private

returns id of the attrib

bool Attrib::DescSet::is2D ( ) const
inlineprivate
bool Attrib::DescSet::isAttribUsed ( const DescID ,
BufferString  
) const
private
bool Attrib::DescSet::isAttribUsed ( const DescID ) const
private
bool Attrib::DescSet::isEmpty ( ) const
inlineprivate
bool Attrib::DescSet::isPresent ( const char *  nm,
bool  usr = true 
) const
inlineprivate
void Attrib::DescSet::moveDescUpDown ( const DescID ,
bool   
)
private
int Attrib::DescSet::nrDescs ( bool  inclstored,
bool  inclhidden 
) const
private

use size() if you just want all

DescSet& Attrib::DescSet::operator= ( const DescSet )
private
Desc& Attrib::DescSet::operator[] ( int  idx)
inlineprivate
const Desc& Attrib::DescSet::operator[] ( int  idx) const
inlineprivate
DescSet* Attrib::DescSet::optimizeClone ( const DescID targetid) const
private
DescSet* Attrib::DescSet::optimizeClone ( const TypeSet< DescID > &  ) const
private
DescSet* Attrib::DescSet::optimizeClone ( const BufferStringSet ) const
private

Only clones stuff needed to calculate the attrib with the ids given

void Attrib::DescSet::removeAll ( bool  kpdefault)
private
void Attrib::DescSet::removeDesc ( const DescID )
private
int Attrib::DescSet::removeUnused ( bool  removestored = false,
bool  kpdefault = true 
)
private

Removes unused hidden attributes, stored attribs if not available or if removestored flag is true. Returns total removed.

bool Attrib::DescSet::setAllInputDescs ( int  ,
const IOPar ,
uiStringSet  
)
private
void Attrib::DescSet::setContainStoredDescOnly ( bool  yn)
private
void Attrib::DescSet::setCouldBeUsedInAnyDimension ( bool  yn)
inlineprivate
static uiString Attrib::DescSet::sFactoryEntryNotFound ( const char *  attrnm)
static
int Attrib::DescSet::size ( ) const
inlineprivate
void Attrib::DescSet::sortDescSet ( )
private
static BufferString Attrib::DescSet::storedIDErrStr ( )
inlinestaticprivate
void Attrib::DescSet::updateInputs ( )
private

Updates inputs for all descs in descset. Necessary after cloning

bool Attrib::DescSet::useOldSteeringPar ( IOPar ,
ObjectSet< Desc > &  ,
uiStringSet  
)
private
bool Attrib::DescSet::usePar ( const IOPar ,
uiStringSet errmsgs = 0 
)
private
static const char* Attrib::DescSet::userRefStr ( )
inlinestaticprivate

Member Data Documentation

bool Attrib::DescSet::couldbeanydim_
protected
DescID Attrib::DescSet::defattribid_
mutableprotected
BufferString Attrib::DescSet::defidstr_
mutableprotected
ObjectSet<Desc> Attrib::DescSet::descs_
protected
CNotifier<DescSet,DescID> Attrib::DescSet::descToBeRemoved
private
uiString Attrib::DescSet::errmsg_
protected
TypeSet<DescID> Attrib::DescSet::ids_
protected
bool Attrib::DescSet::is2d_
protected
bool Attrib::DescSet::storedattronly_
protected

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