Attrib::DescSet Class Reference

Set of attribute descriptions. More...

#include <attribdescset.h>

Inheritance diagram for Attrib::DescSet:

Public Member Functions
	DescSet (bool is2d)
	DescSet (const DescSet &)
	~DescSet ()
DescID	addDesc (Desc *, DescID newid=DescID())
void	cleanUpDescsMissingInputs ()
bool	containsStoredDescOnly () const
bool	couldBeUsedInAnyDimension () const
void	createAndAddMultOutDescs (const DescID &, const TypeSet< int > &, const BufferStringSet &, TypeSet< DescID > &)
DataPointSet *	createDataPointSet (Attrib::DescSetup, bool withstored=true) const
RefMan< Desc >	createDesc (const BufferString &, const IOPar &, const BufferString &)
bool	createSteeringDesc (const IOPar &, BufferString, ObjectSet< Desc > &, int &id, uiStringSet *errmsgs=0)
DescID	createStoredDesc (const MultiID &, int selout, const BufferString &compnm)
RefMan< Desc >	desc (int idx)
ConstRefMan< Desc >	desc (int idx) const
DescID	ensureDefStoredPresent () const
uiString	errMsg () const
bool	exportToDot (const char *nm, const char *fnm) const
void	fillInAttribColRefs (BufferStringSet &) const
void	fillInSelSpecs (Attrib::DescSetup, TypeSet< Attrib::SelSpec > &) const
void	fillInUIInputList (BufferStringSet &) const
void	fillPar (IOPar &) const
void	getAttribNames (BufferStringSet &, bool inclhidden) const
RefMan< Desc >	getDesc (const DescID &id)
ConstRefMan< Desc >	getDesc (const DescID &id) const
RefMan< Desc >	getDescFromUIListEntry (const FileMultiString &)
	will create an empty DataPointSet
RefMan< Desc >	getFirstStored (bool usesteering=true) const
DescID	getID (const char *ref, bool isusrref, bool mustbestored=false, bool usestorinfo=false) const
DescID	getID (const Desc &) const
DescID	getID (int) const
void	getIds (TypeSet< DescID > &) const
DescID	getStoredID (const MultiID &, int selout) const
DescID	getStoredID (const MultiID &, int selout, bool create, bool blindcomp=false, const char *blindcompnm=0)
void	getStoredIds (TypeSet< DescID > &) const
MultiID	getStoredKey (const DescID &) const
void	getStoredNames (BufferStringSet &) const
void	handleOldAttributes (BufferString &, IOPar &, BufferString &, int) const
void	handleOldMathExpression (IOPar &, BufferString &, int) const
void	handleReferenceInput (Desc *)
void	handleStorageOldFormat (IOPar &)
bool	hasStoredInMem () const
int	indexOf (const char *nm, bool usrref=true) const
DescID	insertDesc (Desc *, int, DescID newid=DescID())
bool	is2D () const
bool	isAttribUsed (const DescID &) const
bool	isAttribUsed (const DescID &, BufferString &) const
bool	isEmpty () const
bool	isPresent (const char *nm, bool usr=true) const
void	moveDescUpDown (const DescID &, bool)
int	nrDescs (bool inclstored, bool inclhidden) const
	use size() if you just want all
DescSet &	operator= (const DescSet &)
Desc &	operator[] (int idx)
const Desc &	operator[] (int idx) const
DescSet *	optimizeClone (const BufferStringSet &) const
DescSet *	optimizeClone (const DescID &targetid) const
DescSet *	optimizeClone (const TypeSet< DescID > &) const
void	removeAll (bool kpdefault)
void	removeDesc (const DescID &)
int	removeUnused (bool removestored=false, bool kpdefault=true)
bool	setAllInputDescs (int, const IOPar &, uiStringSet *)
void	setContainStoredDescOnly (bool yn)
void	setCouldBeUsedInAnyDimension (bool yn)
int	size () const
void	sortDescSet ()
void	updateInputs ()
bool	useOldSteeringPar (IOPar &, ObjectSet< Desc > &, uiStringSet *)
bool	usePar (const IOPar &, uiStringSet *errmsgs=0)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object.
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.
CallBacker &	operator= (const CallBacker &)=delete
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()

Static Public Member Functions
static RefMan< Desc >	createDesc (const BufferString &, const IOPar &, const BufferString &, uiStringSet *)
static const char *	definitionStr ()
static const char *	hiddenStr ()
static const char *	highestIDStr ()
static const char *	indexStr ()
static const char *	inputPrefixStr ()
static uiString	sFactoryEntryNotFound (const char *attrnm)
static BufferString	storedIDErrStr ()
static const char *	userRefStr ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
CNotifier< DescSet, DescID >	descToBeRemoved

Protected Member Functions
DescID	getFreeID () const

Protected Attributes
bool	couldbeanydim_
DescID	defattribid_
MultiID	defid_
RefObjectSet< Desc >	descs_
uiString	errmsg_
TypeSet< DescID >	ids_
bool	is2d_
bool	storedattronly_

Private Member Functions
RefMan< Desc >	gtDesc (const DescID &) const

Detailed Description

Set of attribute descriptions.

<>

Constructor & Destructor Documentation

DescSet() [1/2]

Attrib::DescSet::DescSet ( bool is2d )

explicit

DescSet() [2/2]

Attrib::DescSet::DescSet ( const DescSet & )

explicit

~DescSet()

Attrib::DescSet::~DescSet

(

)

Member Function Documentation

addDesc()

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

returns id of the attrib

cleanUpDescsMissingInputs()

void Attrib::DescSet::cleanUpDescsMissingInputs

(

)

containsStoredDescOnly()

bool Attrib::DescSet::containsStoredDescOnly ( ) const

inline

couldBeUsedInAnyDimension()

bool Attrib::DescSet::couldBeUsedInAnyDimension ( ) const

inline

createAndAddMultOutDescs()

void Attrib::DescSet::createAndAddMultOutDescs	(	const DescID &	,
		const TypeSet< int > &	,
		const BufferStringSet &	,
		TypeSet< DescID > &	)

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

createDataPointSet()

DataPointSet * Attrib::DescSet::createDataPointSet	(	Attrib::DescSetup	,
		bool	withstored = true ) const

createDesc() [1/2]

RefMan< Desc > Attrib::DescSet::createDesc	(	const BufferString &	,
		const IOPar &	,
		const BufferString &	)

createDesc() [2/2]

static RefMan< Desc > Attrib::DescSet::createDesc ( const BufferString & , const IOPar & , const BufferString & , uiStringSet *  )

static

createSteeringDesc()

bool Attrib::DescSet::createSteeringDesc	(	const IOPar &	,
		BufferString	,
		ObjectSet< Desc > &	,
		int &	id,
		uiStringSet *	errmsgs = 0 )

createStoredDesc()

DescID Attrib::DescSet::createStoredDesc	(	const MultiID &	,
		int	selout,
		const BufferString &	compnm )

definitionStr()

static const char * Attrib::DescSet::definitionStr ( )

inlinestatic

desc() [1/2]

RefMan< Desc > Attrib::DescSet::desc ( int idx )

inline

desc() [2/2]

ConstRefMan< Desc > Attrib::DescSet::desc ( int idx ) const

inline

ensureDefStoredPresent()

DescID Attrib::DescSet::ensureDefStoredPresent

(

)

const

errMsg()

uiString Attrib::DescSet::errMsg

(

)

const

exportToDot()

bool Attrib::DescSet::exportToDot	(	const char *	nm,
		const char *	fnm ) const

fillInAttribColRefs()

void Attrib::DescSet::fillInAttribColRefs

(

BufferStringSet &

)

const

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

fillInSelSpecs()

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

fillInUIInputList()

void Attrib::DescSet::fillInUIInputList

(

BufferStringSet &

)

const

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

fillPar()

void Attrib::DescSet::fillPar

(

IOPar &

)

const

getAttribNames()

void Attrib::DescSet::getAttribNames	(	BufferStringSet &	,
		bool	inclhidden ) const

getDesc() [1/2]

RefMan< Desc > Attrib::DescSet::getDesc ( const DescID & id )

inline

getDesc() [2/2]

ConstRefMan< Desc > Attrib::DescSet::getDesc ( const DescID & id ) const

inline

getDescFromUIListEntry()

RefMan< Desc > Attrib::DescSet::getDescFromUIListEntry

(

const FileMultiString &

)

will create an empty DataPointSet

getFirstStored()

RefMan< Desc > Attrib::DescSet::getFirstStored

(

bool

usesteering = true

)

const

getFreeID()

DescID Attrib::DescSet::getFreeID ( ) const

protected

getID() [1/3]

DescID Attrib::DescSet::getID	(	const char *	ref,
		bool	isusrref,
		bool	mustbestored = false,
		bool	usestorinfo = false ) const

getID() [2/3]

DescID Attrib::DescSet::getID

(

const Desc &

)

const

getID() [3/3]

DescID Attrib::DescSet::getID

(

int

)

const

getIds()

void Attrib::DescSet::getIds

(

TypeSet< DescID > &

)

const

getStoredID() [1/2]

DescID Attrib::DescSet::getStoredID	(	const MultiID &	,
		int	selout ) const

getStoredID() [2/2]

DescID Attrib::DescSet::getStoredID	(	const MultiID &	,
		int	selout,
		bool	create,
		bool	blindcomp = false,
		const char *	blindcompnm = 0 )

getStoredIds()

void Attrib::DescSet::getStoredIds

(

TypeSet< DescID > &

)

const

getStoredKey()

MultiID Attrib::DescSet::getStoredKey

(

const DescID &

)

const

getStoredNames()

void Attrib::DescSet::getStoredNames

(

BufferStringSet &

)

const

gtDesc()

RefMan< Desc > Attrib::DescSet::gtDesc ( const DescID & ) const

private

handleOldAttributes()

void Attrib::DescSet::handleOldAttributes	(	BufferString &	,
		IOPar &	,
		BufferString &	,
		int	) const

handleOldMathExpression()

void Attrib::DescSet::handleOldMathExpression	(	IOPar &	,
		BufferString &	,
		int	) const

handleReferenceInput()

void Attrib::DescSet::handleReferenceInput

(

Desc *

)

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

handleStorageOldFormat()

void Attrib::DescSet::handleStorageOldFormat

(

IOPar &

)

hasStoredInMem()

bool Attrib::DescSet::hasStoredInMem

(

)

const

hiddenStr()

static const char * Attrib::DescSet::hiddenStr ( )

inlinestatic

highestIDStr()

static const char * Attrib::DescSet::highestIDStr ( )

inlinestatic

indexOf()

int Attrib::DescSet::indexOf	(	const char *	nm,
		bool	usrref = true ) const

indexStr()

static const char * Attrib::DescSet::indexStr ( )

inlinestatic

inputPrefixStr()

static const char * Attrib::DescSet::inputPrefixStr ( )

inlinestatic

insertDesc()

DescID Attrib::DescSet::insertDesc	(	Desc *	,
		int	,
		DescID	newid = DescID() )

returns id of the attrib

is2D()

bool Attrib::DescSet::is2D ( ) const

inline

isAttribUsed() [1/2]

bool Attrib::DescSet::isAttribUsed

(

const DescID &

)

const

isAttribUsed() [2/2]

bool Attrib::DescSet::isAttribUsed	(	const DescID &	,
		BufferString &	) const

isEmpty()

bool Attrib::DescSet::isEmpty ( ) const

inline

isPresent()

bool Attrib::DescSet::isPresent ( const char * nm, bool usr = true ) const

inline

moveDescUpDown()

void Attrib::DescSet::moveDescUpDown	(	const DescID &	,
		bool	)

nrDescs()

int Attrib::DescSet::nrDescs	(	bool	inclstored,
		bool	inclhidden ) const

use size() if you just want all

operator=()

DescSet & Attrib::DescSet::operator=

(

const DescSet &

)

operator[]() [1/2]

Desc & Attrib::DescSet::operator[] ( int idx )

inline

operator[]() [2/2]

const Desc & Attrib::DescSet::operator[] ( int idx ) const

inline

optimizeClone() [1/3]

DescSet * Attrib::DescSet::optimizeClone

(

const BufferStringSet &

)

const

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

optimizeClone() [2/3]

DescSet * Attrib::DescSet::optimizeClone

(

const DescID &

targetid

)

const

optimizeClone() [3/3]

DescSet * Attrib::DescSet::optimizeClone

(

const TypeSet< DescID > &

)

const

removeAll()

void Attrib::DescSet::removeAll

(

bool

kpdefault

)

removeDesc()

void Attrib::DescSet::removeDesc

(

const DescID &

)

removeUnused()

int Attrib::DescSet::removeUnused	(	bool	removestored = false,
		bool	kpdefault = true )

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

setAllInputDescs()

bool Attrib::DescSet::setAllInputDescs	(	int	,
		const IOPar &	,
		uiStringSet *	)

setContainStoredDescOnly()

void Attrib::DescSet::setContainStoredDescOnly

(

bool

yn

)

setCouldBeUsedInAnyDimension()

void Attrib::DescSet::setCouldBeUsedInAnyDimension ( bool yn )

inline

sFactoryEntryNotFound()

static uiString Attrib::DescSet::sFactoryEntryNotFound ( const char * attrnm )

static

size()

int Attrib::DescSet::size ( ) const

inline

sortDescSet()

void Attrib::DescSet::sortDescSet

(

)

storedIDErrStr()

static BufferString Attrib::DescSet::storedIDErrStr ( )

inlinestatic

updateInputs()

void Attrib::DescSet::updateInputs

(

)

Updates inputs for all descs in descset. Necessary after cloning

useOldSteeringPar()

bool Attrib::DescSet::useOldSteeringPar	(	IOPar &	,
		ObjectSet< Desc > &	,
		uiStringSet *	)

usePar()

bool Attrib::DescSet::usePar	(	const IOPar &	,
		uiStringSet *	errmsgs = 0 )

userRefStr()

static const char * Attrib::DescSet::userRefStr ( )

inlinestatic

Member Data Documentation

couldbeanydim_

bool Attrib::DescSet::couldbeanydim_

protected

defattribid_

DescID Attrib::DescSet::defattribid_

mutableprotected

defid_

MultiID Attrib::DescSet::defid_

mutableprotected

descs_

RefObjectSet<Desc> Attrib::DescSet::descs_

protected

descToBeRemoved

CNotifier<DescSet,DescID> Attrib::DescSet::descToBeRemoved

errmsg_

uiString Attrib::DescSet::errmsg_

protected

ids_

TypeSet<DescID> Attrib::DescSet::ids_

protected

is2d_

bool Attrib::DescSet::is2d_

protected

storedattronly_

bool Attrib::DescSet::storedattronly_

protected