OpendTect  7.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
PropertyRef Class Reference

Ref Data for a (usually petrophysical) property. More...

Inheritance diagram for PropertyRef:
[legend]

Public Types

typedef Mnemonic::StdType StdType
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 

Public Member Functions

 PropertyRef (const Mnemonic &=Mnemonic::undef(), const char *nm=nullptr)
 
 PropertyRef (const PropertyRef &)
 
virtual ~PropertyRef ()
 
void addAliases (const BufferStringSet &)
 
const BufferStringSet aliases () const
 
virtual PropertyRefclone () const
 
const MathPropertyfixedDef () const
 be sure hasFixedDef() returns true! More...
 
bool hasFixedDef () const
 
bool hasType (StdType t) const
 
bool isCompatibleWith (const Mnemonic &mn) const
 
bool isCompatibleWith (const PropertyRef &pr) const
 
bool isElastic () const
 
virtual bool isElasticForm () const
 
bool isKnownAs (const char *) const
 
bool isKnownAs (const char *, bool exactmatch) const
 
bool isThickness () const
 
bool isUserDefined () const
 
bool matches (const char *nm, bool matchaliases) const
 
bool matches (const char *nm, bool matchaliases, float *matchval) const
 
const Mnemonicmn () const
 
bool operator!= (const PropertyRef &) const
 
PropertyRefoperator= (const PropertyRef &)
 
bool operator== (const PropertyRef &) const
 
void setFixedDef (const MathProperty *)
 copy will be made More...
 
void setUnit (const char *)
 
StdType stdType () const
 
const UnitOfMeasureunit () const
 For conversions only, do not use to get the label. More...
 
- Public Member Functions inherited from NamedCallBacker
 NamedCallBacker (const char *nm=0)
 
 NamedCallBacker (const NamedCallBacker &)
 
virtual Notifier< NamedCallBacker > & objectToBeDeleted () const
 
bool operator== (const NamedCallBacker &oth) const
 
bool operator== (const NamedObject &oth) const
 
- 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 CallBackertrueCaller ()
 
- 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_typename () const override
 
NamedObjectoperator= (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 PropertyRefget (const IOPar &, Repos::Source)
 
static const char * standardDenAliasStr ()
 
static const char * standardDenStr ()
 
static const char * standardPVelAliasStr ()
 
static const char * standardPVelStr ()
 
static const char * standardSVelAliasStr ()
 
static const char * standardSVelStr ()
 
static const PropertyRefthickness ()
 use this always. It has automatic defaults from SI() More...
 
- Static Public Member Functions inherited from CallBacker
static void createReceiverForCurrentThread ()
 
static void removeReceiverForCurrentThread ()
 

Public Attributes

mExpStruct(General) DispDefs DispDefs disp_
 
CNotifier< PropertyRef, const UnitOfMeasure * > unitChanged
 Returns the previous unit. More...
 

Protected Member Functions

void fillPar (IOPar &) const
 
void setDefaults ()
 
void usePar (const IOPar &)
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 

Static Protected Member Functions

static const MnemonicgetFromLegacy (const Mnemonic *, const char *propnm)
 

Protected Attributes

MathPropertymathdef_ = nullptr
 
const Mnemonicmn_
 
BufferStringSet propaliases_
 
Repos::Source source_ = Repos::Temp
 
const UnitOfMeasureuom_ = nullptr
 
- Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > delalreadytriggered_
 
Notifier< NamedCallBackerdelnotif_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 

Friends

class PropertyRefSet
 
class uiEditPropRef
 

Detailed Description

Ref Data for a (usually petrophysical) property.

We prepare for many variants of the name as is not uncommon in practice (Density, Den, Rho, RhoB, ... you know the drill). The names will be unique

Member Typedef Documentation

◆ StdType

Constructor & Destructor Documentation

◆ PropertyRef() [1/2]

PropertyRef::PropertyRef ( const Mnemonic = Mnemonic::undef(),
const char *  nm = nullptr 
)

◆ PropertyRef() [2/2]

PropertyRef::PropertyRef ( const PropertyRef )

◆ ~PropertyRef()

virtual PropertyRef::~PropertyRef ( )
virtual

Member Function Documentation

◆ addAliases()

void PropertyRef::addAliases ( const BufferStringSet )

◆ aliases()

const BufferStringSet PropertyRef::aliases ( ) const

◆ clone()

virtual PropertyRef* PropertyRef::clone ( ) const
inlinevirtual

Reimplemented in ElasticPropertyRef.

◆ fillPar()

void PropertyRef::fillPar ( IOPar ) const
protected

◆ fixedDef()

const MathProperty& PropertyRef::fixedDef ( ) const
inline

be sure hasFixedDef() returns true!

◆ get()

static PropertyRef* PropertyRef::get ( const IOPar ,
Repos::Source   
)
static

◆ getFromLegacy()

static const Mnemonic* PropertyRef::getFromLegacy ( const Mnemonic ,
const char *  propnm 
)
staticprotected

◆ hasFixedDef()

bool PropertyRef::hasFixedDef ( ) const
inline

◆ hasType()

bool PropertyRef::hasType ( StdType  t) const
inline

◆ isCompatibleWith() [1/2]

bool PropertyRef::isCompatibleWith ( const Mnemonic mn) const
inline

◆ isCompatibleWith() [2/2]

bool PropertyRef::isCompatibleWith ( const PropertyRef pr) const
inline

◆ isElastic()

bool PropertyRef::isElastic ( ) const

◆ isElasticForm()

virtual bool PropertyRef::isElasticForm ( ) const
inlinevirtual

Reimplemented in ElasticPropertyRef.

◆ isKnownAs() [1/2]

bool PropertyRef::isKnownAs ( const char *  ) const

◆ isKnownAs() [2/2]

bool PropertyRef::isKnownAs ( const char *  ,
bool  exactmatch 
) const

◆ isThickness()

bool PropertyRef::isThickness ( ) const
inline

◆ isUserDefined()

bool PropertyRef::isUserDefined ( ) const

◆ matches() [1/2]

bool PropertyRef::matches ( const char *  nm,
bool  matchaliases 
) const

◆ matches() [2/2]

bool PropertyRef::matches ( const char *  nm,
bool  matchaliases,
float *  matchval 
) const

◆ mn()

const Mnemonic& PropertyRef::mn ( ) const
inline

◆ operator!=()

bool PropertyRef::operator!= ( const PropertyRef ) const

◆ operator=()

PropertyRef& PropertyRef::operator= ( const PropertyRef )

◆ operator==()

bool PropertyRef::operator== ( const PropertyRef ) const

◆ setDefaults()

void PropertyRef::setDefaults ( )
protected

◆ setFixedDef()

void PropertyRef::setFixedDef ( const MathProperty )

copy will be made

◆ setUnit()

void PropertyRef::setUnit ( const char *  )

◆ standardDenAliasStr()

static const char* PropertyRef::standardDenAliasStr ( )
inlinestatic

◆ standardDenStr()

static const char* PropertyRef::standardDenStr ( )
inlinestatic

◆ standardPVelAliasStr()

static const char* PropertyRef::standardPVelAliasStr ( )
inlinestatic

◆ standardPVelStr()

static const char* PropertyRef::standardPVelStr ( )
inlinestatic

◆ standardSVelAliasStr()

static const char* PropertyRef::standardSVelAliasStr ( )
inlinestatic

◆ standardSVelStr()

static const char* PropertyRef::standardSVelStr ( )
inlinestatic

◆ stdType()

StdType PropertyRef::stdType ( ) const
inline

◆ thickness()

static const PropertyRef& PropertyRef::thickness ( )
static

use this always. It has automatic defaults from SI()

◆ unit()

const UnitOfMeasure* PropertyRef::unit ( ) const
inline

For conversions only, do not use to get the label.

◆ usePar()

void PropertyRef::usePar ( const IOPar )
protected

Friends And Related Function Documentation

◆ PropertyRefSet

friend class PropertyRefSet
friend

◆ uiEditPropRef

friend class uiEditPropRef
friend

Member Data Documentation

◆ disp_

mExpStruct (General) DispDefs DispDefs PropertyRef::disp_

◆ mathdef_

MathProperty* PropertyRef::mathdef_ = nullptr
protected

◆ mn_

const Mnemonic& PropertyRef::mn_
protected

◆ propaliases_

BufferStringSet PropertyRef::propaliases_
protected

◆ source_

Repos::Source PropertyRef::source_ = Repos::Temp
protected

◆ unitChanged

CNotifier<PropertyRef,const UnitOfMeasure*> PropertyRef::unitChanged

Returns the previous unit.

◆ uom_

const UnitOfMeasure* PropertyRef::uom_ = nullptr
protected

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