Strat::UnitRef Class Reference

Reference data for a stratigraphic unit. More...

Inheritance diagram for Strat::UnitRef:

Public Types
enum	Type { NodeOnly , Leaved , Leaf }

Public Member Functions
	UnitRef (NodeUnitRef *, const char *d=nullptr)
virtual	~UnitRef ()
virtual const OD::String &	code () const =0
OD::Color	color () const
const OD::String &	description () const
virtual void	fill (BufferString &bs) const
virtual const LeafUnitRef *	firstLeaf () const =0
CompoundKey	fullCode () const
virtual void	getPropsFrom (const IOPar &)
virtual bool	hasChildren () const =0
bool	isBelow (const UnitRef *) const
	is given ref parent, grandparent, grandgrand... More...
virtual bool	isEmpty () const
bool	isLeaf () const
bool	isLeaved () const
virtual bool	isParentOf (const UnitRef &) const
virtual bool	isUndef () const
virtual int	level () const =0
CompoundKey	parentCode () const
IOPar &	pars ()
const IOPar &	pars () const
bool	precedes (const UnitRef &) const
	in terms of iterating through tree More...
virtual void	putPropsTo (IOPar &) const
RefTree &	refTree ()
const RefTree &	refTree () const
virtual void	setCode (const char *)
void	setColor (OD::Color)
virtual void	setDescription (const char *d)
void	setUpNode (NodeUnitRef *newpar)
NodeUnitRef *	topNode ()
const NodeUnitRef *	topNode () const
int	treeDepth () const
virtual Type	type () const =0
NodeUnitRef *	upNode (int skip=0)
const NodeUnitRef *	upNode (int skip=0) const
virtual void	use (const char *s)
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. More...
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. More...
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()

Static Public Member Functions
static const char *	sKeyPropsFor ()
static const char *	sKeyTreeProps ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
Notifier< UnitRef >	changed
Notifier< UnitRef >	toBeDeleted

Protected Member Functions
void	doFill (BufferString &, int) const
void	doUse (const char *, int *)
void	notifChange (bool isrem=false)

Protected Attributes
OD::Color	color_
BufferString	desc_
IOPar	pars_
NodeUnitRef *	upnode_

Friends
class	NodeUnitRef

Detailed Description

Reference data for a stratigraphic unit.

Every stratigraphy is a tree of units. A stratigraphy consists of reference units - every part of the subsurface can be attached to a reference unit.

<>

Member Enumeration Documentation

Type

enum Strat::UnitRef::Type

Enumerator
NodeOnly
Leaved
Leaf

Constructor & Destructor Documentation

UnitRef()

Strat::UnitRef::UnitRef	(	NodeUnitRef *	,
		const char *	d = nullptr
	)

~UnitRef()

virtual Strat::UnitRef::~UnitRef ( )

virtual

Member Function Documentation

code()

virtual const OD::String& Strat::UnitRef::code ( ) const

pure virtual

Implemented in Strat::LeafUnitRef, and Strat::NodeUnitRef.

color()

OD::Color Strat::UnitRef::color ( ) const

inline

description()

const OD::String& Strat::UnitRef::description ( ) const

inline

doFill()

void Strat::UnitRef::doFill ( BufferString &  , int    ) const

protected

doUse()

void Strat::UnitRef::doUse ( const char *  , int *    )

protected

fill()

virtual void Strat::UnitRef::fill ( BufferString &  bs ) const

inlinevirtual

Reimplemented in Strat::LeafUnitRef, and Strat::LeavedUnitRef.

firstLeaf()

virtual const LeafUnitRef* Strat::UnitRef::firstLeaf ( ) const

pure virtual

Implemented in Strat::LeafUnitRef, Strat::LeavedUnitRef, and Strat::NodeOnlyUnitRef.

fullCode()

CompoundKey Strat::UnitRef::fullCode

(

)

const

getPropsFrom()

virtual void Strat::UnitRef::getPropsFrom ( const IOPar &  )

virtual

Reimplemented in Strat::LeafUnitRef, and Strat::NodeUnitRef.

hasChildren()

virtual bool Strat::UnitRef::hasChildren ( ) const

pure virtual

Implemented in Strat::LeafUnitRef, and Strat::NodeUnitRef.

isBelow()

bool Strat::UnitRef::isBelow

(

const UnitRef *

)

const

is given ref parent, grandparent, grandgrand...

isEmpty()

virtual bool Strat::UnitRef::isEmpty ( ) const

inlinevirtual

Reimplemented in Strat::NodeUnitRef.

isLeaf()

bool Strat::UnitRef::isLeaf ( ) const

inline

isLeaved()

bool Strat::UnitRef::isLeaved ( ) const

inline

isParentOf()

virtual bool Strat::UnitRef::isParentOf ( const UnitRef &  ) const

inlinevirtual

Reimplemented in Strat::NodeUnitRef.

isUndef()

virtual bool Strat::UnitRef::isUndef ( ) const

inlinevirtual

Reimplemented in Strat::LeafUnitRef.

level()

virtual int Strat::UnitRef::level ( ) const

pure virtual

Implemented in Strat::LeafUnitRef, Strat::NodeUnitRef, and Strat::RefTree.

notifChange()

void Strat::UnitRef::notifChange ( bool  isrem = false )

protected

parentCode()

CompoundKey Strat::UnitRef::parentCode

(

)

const

pars() [1/2]

IOPar& Strat::UnitRef::pars ( )

inline

pars() [2/2]

const IOPar& Strat::UnitRef::pars ( ) const

inline

precedes()

bool Strat::UnitRef::precedes

(

const UnitRef &

)

const

in terms of iterating through tree

putPropsTo()

virtual void Strat::UnitRef::putPropsTo ( IOPar &  ) const

virtual

Reimplemented in Strat::NodeUnitRef.

refTree() [1/2]

RefTree& Strat::UnitRef::refTree

(

)

refTree() [2/2]

const RefTree& Strat::UnitRef::refTree

(

)

const

setCode()

virtual void Strat::UnitRef::setCode ( const char *  )

inlinevirtual

Reimplemented in Strat::NodeUnitRef.

setColor()

void Strat::UnitRef::setColor

(

OD::Color

)

setDescription()

virtual void Strat::UnitRef::setDescription ( const char *  d )

inlinevirtual

setUpNode()

void Strat::UnitRef::setUpNode ( NodeUnitRef *  newpar )

inline

sKeyPropsFor()

static const char* Strat::UnitRef::sKeyPropsFor ( )

inlinestatic

sKeyTreeProps()

static const char* Strat::UnitRef::sKeyTreeProps ( )

inlinestatic

topNode() [1/2]

NodeUnitRef * Strat::UnitRef::topNode ( )

inline

topNode() [2/2]

const NodeUnitRef * Strat::UnitRef::topNode ( ) const

inline

treeDepth()

int Strat::UnitRef::treeDepth

(

)

const

type()

virtual Type Strat::UnitRef::type ( ) const

pure virtual

Implemented in Strat::LeafUnitRef, Strat::LeavedUnitRef, and Strat::NodeOnlyUnitRef.

upNode() [1/2]

NodeUnitRef* Strat::UnitRef::upNode

(

int

skip = 0

)

upNode() [2/2]

const NodeUnitRef* Strat::UnitRef::upNode ( int  skip = 0 ) const

inline

use()

virtual void Strat::UnitRef::use ( const char *  s )

inlinevirtual

Reimplemented in Strat::LeafUnitRef, and Strat::LeavedUnitRef.

Friends And Related Function Documentation

NodeUnitRef

friend class NodeUnitRef

friend

Member Data Documentation

changed

Notifier<UnitRef> Strat::UnitRef::changed

color_

OD::Color Strat::UnitRef::color_

protected

desc_

BufferString Strat::UnitRef::desc_

protected

pars_

IOPar Strat::UnitRef::pars_

protected

toBeDeleted

Notifier<UnitRef> Strat::UnitRef::toBeDeleted

upnode_

NodeUnitRef* Strat::UnitRef::upnode_

protected