DataPack Class Reference

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

Inheritance diagram for DataPack:

Classes
class	FullID

Public Types
typedef FullID::PackID	ID
typedef FullID::MgrID	MgrID
Public Types inherited from Monitorable
typedef int	ChangeType
typedef int64_t	IDType
typedef int64_t	DirtyCountType
typedef CNotifier< Monitorable, ChangeData >	ChangeDataNotifier

Public Member Functions
	DataPack (const char *categry)
	DataPack (const DataPack &)
DataPack &	operator= (const DataPack &)
bool	operator== (const DataPack &) const
bool	operator!= (const DataPack &oth) const
virtual DataPack *	clone () const
ChangeType	compareWith (const Monitorable &) const
int	isOK () const
ID	id () const
FullID	fullID (MgrID mgrid) const
const char *	category () const
float	nrKBytes () const
bool	dumpInfo (IOPar &iop) const
DBKey	dbKey () const
void	setDBKey (const DBKey &_set_to_)
int	nrArrays () const
const ArrayND< float > *	arrayData (int iarr) const
void	release ()
DataPack *	obtain ()
Public Member Functions inherited from SharedObject
	SharedObject (const char *nm=0)
	SharedObject (const SharedObject &)
SharedObject &	operator= (const SharedObject &)
bool	operator== (const SharedObject &) const
bool	operator!= (const SharedObject &oth) const
ChangeType	compareWith (const Monitorable &) const
Public Member Functions inherited from NamedMonitorable
	NamedMonitorable (const char *nm=0)
	NamedMonitorable (const NamedObject &)
virtual	~NamedMonitorable ()
	NamedMonitorable (const NamedMonitorable &)
NamedMonitorable &	operator= (const NamedMonitorable &)
bool	operator== (const NamedMonitorable &) const
bool	operator!= (const NamedMonitorable &oth) const
virtual NamedMonitorable *	getClone () const
virtual BufferString	getName () const
virtual void	setName (const char *)
Public Member Functions inherited from Monitorable
	Monitorable (const Monitorable &)
virtual	~Monitorable ()
Monitorable &	operator= (const Monitorable &)
bool	operator== (const Monitorable &) const
virtual ChangeDataNotifier &	objectChanged () const
virtual Notifier< Monitorable > &	objectToBeDeleted () const
virtual void	touch () const
virtual DirtyCountType	dirtyCount () const
void	sendChangeNotification (const ChangeData &) const
void	sendEntireObjectChangeNotification () const
void	transferNotifsTo (const Monitorable &, const CallBacker *onlyfor=0) 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	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Static Public Member Functions
static Notifier< DataPack > &	instanceCreated ()
static const char *	sKeyCategory ()
static ID	cNoID ()
static ChangeType	cDBKeyChg ()
Static Public Member Functions inherited from SharedObject
static Notifier< SharedObject > &	instanceCreated ()
Static Public Member Functions inherited from NamedMonitorable
static Notifier< NamedMonitorable > &	instanceCreated ()
static ChangeType	cNameChange ()
Static Public Member Functions inherited from Monitorable
static Notifier< Monitorable > &	instanceCreated ()
	defines static instanceCreated() More...
static ChangeType	cEntireObjectChange ()
static ChangeType	cNoChange ()
static IDType	cUnspecChgID ()
static IDType	cEntireObjectChgID ()
static ChangeType	changeNotificationTypeOf (CallBacker *)
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Protected Member Functions
void	copyAll (const DataPack &)
virtual	~DataPack ()
virtual const char *	gtCategory () const
virtual float	gtNrKBytes () const =0
virtual void	doDumpInfo (IOPar &) const
virtual int	gtNrArrays () const
virtual const ArrayND< float > *	gtArrayData (int) const
void	setManager (const DataPackMgr *)
void	setCategory (const char *c)
Protected Member Functions inherited from SharedObject
void	copyAll (const SharedObject &)
virtual	~SharedObject ()
Protected Member Functions inherited from NamedMonitorable
void	copyAll (const NamedMonitorable &)
Protected Member Functions inherited from Monitorable
	Monitorable ()
void	copyAll (const Monitorable &)
void	sendChgNotif (AccessLocker &, const ChangeData &) const
	calls objectChanged with released lock More...
void	sendChgNotif (AccessLocker &, ChangeType, IDType) const
	calls objectChanged with released lock More...
void	sendDelNotif () const
void	stopChangeNotifications () const
void	resumeChangeNotifications () const
template<class T >
T	getMemberSimple (const T &) const
	the get function used by mImplSimpleMonitoredGet More...
template<class TMember , class TSetTo >
void	setMemberSimple (TMember &, TSetTo, ChangeType, IDType)
	the set function used by mImplSimpleMonitoredSet More...
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

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

Protected Attributes
const ID	id_
const BufferString	category_
DBKey	dbkey_
const DataPackMgr *	manager_
Protected Attributes inherited from Monitorable
Threads::Lock	accesslock_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
void	copyClassData (const DataPack &)
ChangeType	compareClassData (const DataPack &) const

Friends
class	DataPackMgr

Additional Inherited Members
Protected Types inherited from Monitorable
typedef Threads::Atomic< DirtyCountType >	DirtyCounter

Detailed Description

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

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

A DataPack may be tied to stored object. If so, the optional dbKey() is valid.

A DataPack will often contain data in the form of ArrayND<float>. Because this is so common there is access to this data from this top level.

Member Typedef Documentation

typedef FullID::PackID DataPack::ID

typedef FullID::MgrID DataPack::MgrID

Constructor & Destructor Documentation

DataPack::DataPack

(

const char *

categry

)

DataPack::DataPack

(

const DataPack &

)

virtual DataPack::~DataPack ( )

protectedvirtual

Member Function Documentation

const ArrayND<float>* DataPack::arrayData ( int  iarr ) const

inline

const char* DataPack::category ( ) const

inline

static ChangeType DataPack::cDBKeyChg ( )

inlinestatic

virtual DataPack* DataPack::clone ( ) const

inlinevirtual

Reimplemented from SharedObject.

Reimplemented in BufferDataPack.

static ID DataPack::cNoID ( )

inlinestatic

ChangeType DataPack::compareClassData ( const DataPack &  ) const

private

ChangeType DataPack::compareWith ( const Monitorable &  ) const

virtual

Reimplemented from Monitorable.

Reimplemented in BufferDataPack.

void DataPack::copyAll ( const DataPack &  )

protected

void DataPack::copyClassData ( const DataPack &  )

private

DBKey DataPack::dbKey ( ) const

inline

virtual void DataPack::doDumpInfo ( IOPar &  ) const

protectedvirtual

Reimplemented in DataPointSet, VolumeDataPack, FlatDataPack, and RegularSeisDataPack.

bool DataPack::dumpInfo ( IOPar &  iop ) const

inline

FullID DataPack::fullID ( MgrID  mgrid ) const

inline

static ID DataPack::getNewID ( )

staticprotected

ensures a global data pack ID

virtual const ArrayND<float>* DataPack::gtArrayData ( int  ) const

inlineprotectedvirtual

Reimplemented in VolumeDataPack, and FlatDataPack.

virtual const char* DataPack::gtCategory ( ) const

inlineprotectedvirtual

virtual int DataPack::gtNrArrays ( ) const

inlineprotectedvirtual

Reimplemented in VolumeDataPack, and FlatDataPack.

virtual float DataPack::gtNrKBytes ( ) const

protectedpure virtual

Implemented in DataPointSet, VolumeDataPack, SeisFlatDataPack, GatherSetDataPack, BufferDataPack, and FlatDataPack.

ID DataPack::id ( ) const

inline

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

static

int DataPack::isOK ( ) const

inline

int DataPack::nrArrays ( ) const

inline

float DataPack::nrKBytes ( ) const

inline

DataPack* DataPack::obtain

(

)

bool DataPack::operator!= ( const DataPack &  oth ) const

inline

DataPack& DataPack::operator=

(

const DataPack &

)

bool DataPack::operator==

(

const DataPack &

)

const

void DataPack::release

(

)

void DataPack::setCategory ( const char *  c )

inlineprotected

void DataPack::setDBKey ( const DBKey &  _set_to_ )

inline

void DataPack::setManager ( const DataPackMgr *  )

protected

static float DataPack::sKb2MbFac ( )

staticprotected

1 / 1024

static const char* DataPack::sKeyCategory ( )

static

Friends And Related Function Documentation

friend class DataPackMgr

friend

Member Data Documentation

const BufferString DataPack::category_

protected

DBKey DataPack::dbkey_

protected

const ID DataPack::id_

protected

const DataPackMgr* DataPack::manager_

protected