Pick::Set Class Reference

Monitorable set of pick locations. More...

Inheritance diagram for Pick::Set:

Classes
class	Disp

Public Types
typedef TypeSet< Location >::size_type	size_type
typedef size_type	IdxType
Public Types inherited from Monitorable
typedef int	ChangeType
typedef int64_t	IDType
typedef int64_t	DirtyCountType
typedef CNotifier< Monitorable, ChangeData >	ChangeDataNotifier

Public Member Functions
	mDefIntegerIDType (IdxType, LocID)
	Set (const char *nm=0, const char *category=0)
	mDeclInstanceCreatedNotifierAccess (Set)
	mDeclMonitorableAssignment (Set)
bool	isPolygon () const
void	setIsPolygon (bool yn=true)
void	setCategory (const char *)
BufferString	type () const
	sKey::Polygon() or sKey::PickSet() More...
BufferString	category () const
bool	isEmpty () const
size_type	size () const
bool	validLocID (LocID) const
IdxType	idxFor (LocID) const
LocID	locIDAfter (LocID) const
bool	validIdx (IdxType) const
LocID	locIDFor (IdxType) const
Location	get (LocID) const
Coord	getPos (LocID) const
double	getZ (LocID) const
Location	first () const
Location	getByIndex (IdxType) const
Set &	setEmpty ()
Set &	append (const Set &)
LocID	insertBefore (LocID, const Location &)
LocID	add (const Location &)
LocID	remove (LocID)
	returns ID of loc taking its place More...
Set &	set (LocID, const Location &, bool istemp=false)
Set &	setPos (LocID, const Coord &, bool istemp=false)
Set &	setZ (LocID, double, bool istemp=false)
Set &	setByIndex (IdxType, const Location &, bool istemp=false)
bool	isMultiGeom () const
Pos::GeomID	firstGeomID () const
bool	has2D () const
bool	has3D () const
bool	hasOnly2D () const
bool	hasOnly3D () const
void	getPolygon (ODPolygon< double > &) const
void	getPolygon (ODPolygon< float > &) const
void	getLocations (TypeSet< Coord > &) const
float	getXYArea () const
	Only for closed polygons. Returns in m^2. More...
LocID	find (const TrcKey &) const
LocID	nearestLocation (const Coord &) const
LocID	nearestLocation (const Coord3 &, bool ignorez=false) const
bool	removeWithPolygon (const ODPolygon< double > &, bool inside=true)
	mImplSimpleMonitoredGetSet (inline, pars, setPars, IOPar, pars_, cParsChange()) void fillPar(IOPar &) const
bool	usePar (const IOPar &)
void	updateInPar (const char *ky, const char *val)
	mImplSimpleMonitoredGetSet (inline, getDisp, setDisp, Disp, disp_, cDispChange()) mImplSimpleMonitoredGetSet(inline
disp_	cDispChange ()) mImplSimpleMonitoredGetSet(inline
disp_ disp_	cDispChange ()) mImplSimpleMonitoredGetSet(inline
disp_ disp_ disp_ mkstyle_	cDispChange ()) mImplSimpleMonitoredGetSet(inline
disp_ disp_ disp_ mkstyle_ disp_ mkstyle_	cDispChange ()) static ChangeType cDispChange()
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
virtual SharedObject *	clone () 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 ChangeType	cParsChange ()
static ChangeType	cLocationInsert ()
static ChangeType	cLocationRemove ()
static ChangeType	cLocationPreChange ()
static ChangeType	cLocationChange ()
static ChangeType	cLocationChangeTemp ()
static bool	isLocationUpdate (ChangeType ct)
static bool	isLocationChange (ChangeType ct)
static bool	isTempChange (ChangeType ct)
static const Set &	emptySet ()
static Set &	dummySet ()
static const char *	sKeyMarkerType ()
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 ()

Public Attributes
	connection
	setConnection
disp_	connect_
disp_	markerStyle
disp_	setMarkerStyle
disp_ disp_	mkstyle_
disp_ disp_	dispColor
disp_ disp_	setDispColor
disp_ disp_	Color
disp_ disp_ disp_ mkstyle_	color_
disp_ disp_ disp_ mkstyle_	dispSize
disp_ disp_ disp_ mkstyle_	setDispSize
disp_ disp_ disp_ mkstyle_	int
disp_ disp_ disp_ mkstyle_ disp_ mkstyle_	size_

Protected Member Functions
	~Set ()
IdxType	gtIdxFor (LocID) const
LocID	insNewLocID (IdxType, AccessLocker &)
void	replaceID (LocID from, LocID to)
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...

Protected Attributes
TypeSet< Location >	locs_
TypeSet< LocID >	locids_
Disp	disp_
IOPar	pars_
Threads::Atomic< IdxType >	curlocidnr_
Protected Attributes inherited from Monitorable
Threads::Lock	accesslock_
Protected Attributes inherited from NamedObject
BufferString	name_

Static Protected Attributes
static const Set	emptyset_
static Set	dummyset_

Friends
class	SetIter
class	SetIter4Edit
class	SetChangeRecord

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

Detailed Description

Monitorable set of pick locations.

A Pick::Set is either a loose bunch of locations, or a connected set of points: a polygon. Apart from this, a set may be labeled to be part of a 'category', like 'ArrowAnnotations'.

Each location has its own unique ID, the LocID.

Member Typedef Documentation

typedef size_type Pick::Set::IdxType

typedef TypeSet<Location>::size_type Pick::Set::size_type

Constructor & Destructor Documentation

Pick::Set::Set	(	const char *	nm = 0,
		const char *	category = 0
	)

Pick::Set::~Set ( )

protected

Member Function Documentation

LocID Pick::Set::add

(

const Location &

)

Set& Pick::Set::append

(

const Set &

)

BufferString Pick::Set::category

(

)

const

disp_ Pick::Set::cDispChange

(

)

disp_ disp_ Pick::Set::cDispChange

(

)

disp_ disp_ disp_ mkstyle_ Pick::Set::cDispChange

(

)

disp_ disp_ disp_ mkstyle_ disp_ mkstyle_ Pick::Set::cDispChange ( )

inline

static ChangeType Pick::Set::cLocationChange ( )

inlinestatic

static ChangeType Pick::Set::cLocationChangeTemp ( )

inlinestatic

static ChangeType Pick::Set::cLocationInsert ( )

inlinestatic

static ChangeType Pick::Set::cLocationPreChange ( )

inlinestatic

static ChangeType Pick::Set::cLocationRemove ( )

inlinestatic

static ChangeType Pick::Set::cParsChange ( )

inlinestatic

static Set& Pick::Set::dummySet ( )

inlinestatic

static const Set& Pick::Set::emptySet ( )

inlinestatic

LocID Pick::Set::find

(

const TrcKey &

)

const

Location Pick::Set::first

(

)

const

Pos::GeomID Pick::Set::firstGeomID

(

)

const

Location Pick::Set::get

(

LocID

)

const

Location Pick::Set::getByIndex

(

IdxType

)

const

void Pick::Set::getLocations

(

TypeSet< Coord > &

)

const

void Pick::Set::getPolygon

(

ODPolygon< double > &

)

const

void Pick::Set::getPolygon

(

ODPolygon< float > &

)

const

Coord Pick::Set::getPos

(

LocID

)

const

float Pick::Set::getXYArea

(

)

const

Only for closed polygons. Returns in m^2.

double Pick::Set::getZ

(

LocID

)

const

IdxType Pick::Set::gtIdxFor ( LocID  ) const

protected

bool Pick::Set::has2D

(

)

const

bool Pick::Set::has3D

(

)

const

bool Pick::Set::hasOnly2D

(

)

const

bool Pick::Set::hasOnly3D

(

)

const

IdxType Pick::Set::idxFor

(

LocID

)

const

LocID Pick::Set::insertBefore	(	LocID	,
		const Location &
	)

LocID Pick::Set::insNewLocID ( IdxType  , AccessLocker &    )

protected

bool Pick::Set::isEmpty ( ) const

inline

static bool Pick::Set::isLocationChange ( ChangeType  ct )

inlinestatic

static bool Pick::Set::isLocationUpdate ( ChangeType  ct )

inlinestatic

bool Pick::Set::isMultiGeom

(

)

const

bool Pick::Set::isPolygon

(

)

const

static bool Pick::Set::isTempChange ( ChangeType  ct )

inlinestatic

LocID Pick::Set::locIDAfter

(

LocID

)

const

LocID Pick::Set::locIDFor

(

IdxType

)

const

Pick::Set::mDeclInstanceCreatedNotifierAccess

(

Set

)

Pick::Set::mDeclMonitorableAssignment

(

Set

)

Pick::Set::mDefIntegerIDType	(	IdxType	,
		LocID
	)

Pick::Set::mImplSimpleMonitoredGetSet	(	inline	,
		pars	,
		setPars	,
		IOPar	,
		pars_	,
		cParsChange()
	)		const

Pick::Set::mImplSimpleMonitoredGetSet	(	inline	,
		getDisp	,
		setDisp	,
		Disp	,
		disp_	,
		cDispChange()
	)

LocID Pick::Set::nearestLocation

(

const Coord &

)

const

LocID Pick::Set::nearestLocation	(	const Coord3 &	,
		bool	ignorez = false
	)		const

LocID Pick::Set::remove

(

LocID

)

returns ID of loc taking its place

bool Pick::Set::removeWithPolygon	(	const ODPolygon< double > &	,
		bool	inside = true
	)

void Pick::Set::replaceID ( LocID  from, LocID  to  )

protected

Set& Pick::Set::set	(	LocID	,
		const Location &	,
		bool	istemp = false
	)

Set& Pick::Set::setByIndex	(	IdxType	,
		const Location &	,
		bool	istemp = false
	)

void Pick::Set::setCategory

(

const char *

)

Set& Pick::Set::setEmpty

(

)

void Pick::Set::setIsPolygon

(

bool

yn = true

)

Set& Pick::Set::setPos	(	LocID	,
		const Coord &	,
		bool	istemp = false
	)

Set& Pick::Set::setZ	(	LocID	,
		double	,
		bool	istemp = false
	)

size_type Pick::Set::size

(

)

const

static const char* Pick::Set::sKeyMarkerType ( )

inlinestatic

BufferString Pick::Set::type

(

)

const

sKey::Polygon() or sKey::PickSet()

void Pick::Set::updateInPar	(	const char *	ky,
		const char *	val
	)

bool Pick::Set::usePar

(

const IOPar &

)

bool Pick::Set::validIdx

(

IdxType

)

const

bool Pick::Set::validLocID

(

LocID

)

const

Friends And Related Function Documentation

friend class SetChangeRecord

friend

friend class SetIter

friend

friend class SetIter4Edit

friend

Member Data Documentation

disp_ disp_ Pick::Set::Color

disp_ disp_ disp_ mkstyle_ Pick::Set::color_

disp_ Pick::Set::connect_

Pick::Set::connection

Threads::Atomic<IdxType> Pick::Set::curlocidnr_

mutableprotected

Disp Pick::Set::disp_

protected

disp_ disp_ Pick::Set::dispColor

disp_ disp_ disp_ mkstyle_ Pick::Set::dispSize

Set Pick::Set::dummyset_

staticprotected

const Set Pick::Set::emptyset_

staticprotected

disp_ disp_ disp_ mkstyle_ Pick::Set::int

TypeSet<LocID> Pick::Set::locids_

protected

TypeSet<Location> Pick::Set::locs_

protected

disp_ Pick::Set::markerStyle

disp_ disp_ Pick::Set::mkstyle_

IOPar Pick::Set::pars_

protected

Pick::Set::setConnection

disp_ disp_ Pick::Set::setDispColor

disp_ disp_ disp_ mkstyle_ Pick::Set::setDispSize

disp_ Pick::Set::setMarkerStyle

disp_ disp_ disp_ mkstyle_ disp_ mkstyle_ Pick::Set::size_