DataPack Class Reference

A data packet: data+positioning and more that needs to be shared. More...

Inheritance diagram for DataPack:

Public Types
typedef MultiID	FullID
typedef int	ID
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	DataPack (const char *categry)
	DataPack (const DataPack &)
virtual	~DataPack ()
virtual const char *	category () const
virtual void	dumpInfo (IOPar &) const
FullID	fullID (int mgrid) const
ID	id () const
virtual bool	isOK () const
virtual float	nrKBytes () const =0
DataPack *	obtain ()
void	release ()
Threads::Lock &	updateLock () const
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
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 &)
virtual const name_type &	name () const
NamedObject &	operator= (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 ID	cNoID ()
static ID	cUdfID ()
static ID	getID (const FullID &fid)
static Notifier< DataPack > &	instanceCreated ()
static const char *	sKeyCategory ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
void	setCategory (const char *c)
void	setManager (const DataPackMgr *)
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Static Protected Member Functions
static ID	getNewID ()
	ensures a global data pack ID More...
static float	sKb2MbFac ()
	1 / 1024 More...

Protected Attributes
const BufferString	category_
const ID	id_
const DataPackMgr *	manager_
int	nrusers_
Threads::Lock	nruserslock_
Threads::Lock	updatelock_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Friends
class	DataPackMgr

Detailed Description

A data packet: data+positioning and more that needs to be shared.

The 'category' is meant like: 'Prestack gather' 'Wavelet' 'Fault surface'

<>

Member Typedef Documentation

FullID

typedef MultiID DataPack::FullID

ID

typedef int DataPack::ID

Constructor & Destructor Documentation

DataPack() [1/2]

DataPack::DataPack

(

const char *

categry

)

DataPack() [2/2]

DataPack::DataPack

(

const DataPack &

)

~DataPack()

virtual DataPack::~DataPack ( )

virtual

Member Function Documentation

category()

virtual const char* DataPack::category ( ) const

inlinevirtual

cNoID()

static ID DataPack::cNoID ( )

inlinestatic

cUdfID()

static ID DataPack::cUdfID ( )

inlinestatic

dumpInfo()

virtual void DataPack::dumpInfo ( IOPar &  ) const

virtual

Reimplemented in RegularSeisDataPack, DataPointSet, SeisDataPack, VolumeDataPack, FlatDataPack, and EM::DataPackCommon.

fullID()

FullID DataPack::fullID ( int  mgrid ) const

inline

getID()

static ID DataPack::getID ( const FullID &  fid )

inlinestatic

getNewID()

static ID DataPack::getNewID ( )

staticprotected

ensures a global data pack ID

id()

ID DataPack::id ( ) const

inline

instanceCreated()

static Notifier< DataPack >& DataPack::instanceCreated ( )

static

isOK()

virtual bool DataPack::isOK ( ) const

inlinevirtual

nrKBytes()

virtual float DataPack::nrKBytes ( ) const

pure virtual

Implemented in SeisFlatDataPack, PreStack::GatherSetDataPack, DataPointSet, SeisDataPack, VolumeDataPack, FlatDataPack, and BufferDataPack.

obtain()

DataPack* DataPack::obtain

(

)

release()

void DataPack::release

(

)

setCategory()

void DataPack::setCategory ( const char *  c )

inlineprotected

setManager()

void DataPack::setManager ( const DataPackMgr *  )

protected

sKb2MbFac()

static float DataPack::sKb2MbFac ( )

staticprotected

1 / 1024

sKeyCategory()

static const char* DataPack::sKeyCategory ( )

static

updateLock()

Threads::Lock& DataPack::updateLock ( ) const

inline

Friends And Related Function Documentation

DataPackMgr

friend class DataPackMgr

friend

Member Data Documentation

category_

const BufferString DataPack::category_

protected

id_

const ID DataPack::id_

protected

manager_

const DataPackMgr* DataPack::manager_

protected

nrusers_

int DataPack::nrusers_

mutableprotected

nruserslock_

Threads::Lock DataPack::nruserslock_

mutableprotected

updatelock_

Threads::Lock DataPack::updatelock_

mutableprotected