Table::TargetInfo Class Reference

Description of a Logical piece of information. More...

Inheritance diagram for Table::TargetInfo:

Classes
struct	Form
	Specific form in which a piece of information can be found. More...
struct	Selection
	Selected element/positioning This selects the specific form and where/how it can be found in the file, or explicit values for the form elements. More...

Public Member Functions
	TargetInfo (const char *nm, const DataInpSpec &spec, ReqSpec rs=Optional, Mnemonic::StdType p=Mnemonic::Other)
	TargetInfo (const char *nm, DataInpSpec *spec, ReqSpec rs=Optional, Mnemonic::StdType p=Mnemonic::Other)
	TargetInfo (const char *nm, ReqSpec rs=Optional)
	~TargetInfo ()
TargetInfo &	add (const char *nm, const DataInpSpec &spec)
TargetInfo &	add (const char *nm, DataInpSpec *spec=0)
TargetInfo &	add (Form *frm)
Coord	convert (const Coord &) const
void	fillPar (IOPar &) const
Form &	form (int idx)
const Form &	form (int idx) const
int	formNr (const char *formnm) const
bool	isHidden () const
bool	isOptional () const
bool	needsConversion () const
int	nrForms () const
Mnemonic::StdType	propertyType () const
void	setPropertyType (Mnemonic::StdType p)
void	usePar (const IOPar &)
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_type &	name () const override
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 TargetInfo *	mk2DHorPosition (bool isreq, bool withsp=false, bool withll=false, ConstRefMan< Coords::CoordSystem > crs=nullptr)
static TargetInfo *	mk2DHorPosition (bool isreq, ConstRefMan< Coords::CoordSystem > crs=nullptr)
static TargetInfo *	mkDepthPosition (bool isreq, bool withunits=true)
static TargetInfo *	mkHorPosition (bool isreq, bool wic=true, bool wll=false, bool wcrs=true, ConstRefMan< Coords::CoordSystem > crs=nullptr)
	form(0)=(X,Y), form(1)=inl/crl, form(1/2)=long/lat More...
static TargetInfo *	mkTimePosition (bool isreq, bool withunits=true)
static TargetInfo *	mkZPosition (bool isreq, bool withunits=true)
static const char *	sKeyInlCrl ()
static const char *	sKeyLatLong ()
static const char *	sKeyXY ()

Public Attributes
Selection	selection_

Static Protected Member Functions
static TargetInfo *	mkZPos (bool, bool wu=false, int zopt=0)

Protected Attributes
ObjectSet< Form >	forms_
Mnemonic::StdType	proptype_
ReqSpec	req_
Protected Attributes inherited from NamedObject
BufferString	name_

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Detailed Description

Description of a Logical piece of information.

In most simple situations, you need to know the column of some data, or the row/col of a header. Then you just describe it as: Table::TargetInfo ti( "Number of samples", IntInpSpec(), Table::Required );

In more complex situations, data can be present or offered in various ways. For example, an interval can be specified as start/stop or start/width. This would lead to the definition of multiple 'Form' objects.

<>

Constructor & Destructor Documentation

TargetInfo() [1/3]

Table::TargetInfo::TargetInfo ( const char *  nm, ReqSpec  rs = Optional  )

inline

TargetInfo() [2/3]

Table::TargetInfo::TargetInfo ( const char *  nm, DataInpSpec *  spec, ReqSpec  rs = Optional, Mnemonic::StdType  p = Mnemonic::Other  )

inline

TargetInfo() [3/3]

Table::TargetInfo::TargetInfo ( const char *  nm, const DataInpSpec &  spec, ReqSpec  rs = Optional, Mnemonic::StdType  p = Mnemonic::Other  )

inline

~TargetInfo()

Table::TargetInfo::~TargetInfo ( )

inline

Member Function Documentation

add() [1/3]

TargetInfo& Table::TargetInfo::add ( const char *  nm, const DataInpSpec &  spec  )

inline

add() [2/3]

TargetInfo& Table::TargetInfo::add ( const char *  nm, DataInpSpec *  spec = 0  )

inline

add() [3/3]

TargetInfo& Table::TargetInfo::add ( Form *  frm )

inline

convert()

Coord Table::TargetInfo::convert

(

const Coord &

)

const

fillPar()

void Table::TargetInfo::fillPar

(

IOPar &

)

const

form() [1/2]

Form& Table::TargetInfo::form ( int  idx )

inline

form() [2/2]

const Form& Table::TargetInfo::form ( int  idx ) const

inline

formNr()

int Table::TargetInfo::formNr ( const char *  formnm ) const

inline

isHidden()

bool Table::TargetInfo::isHidden ( ) const

inline

isOptional()

bool Table::TargetInfo::isOptional ( ) const

inline

mk2DHorPosition() [1/2]

static TargetInfo* Table::TargetInfo::mk2DHorPosition ( bool  isreq, bool  withsp = false, bool  withll = false, ConstRefMan< Coords::CoordSystem >  crs = nullptr  )

static

mk2DHorPosition() [2/2]

static TargetInfo* Table::TargetInfo::mk2DHorPosition ( bool  isreq, ConstRefMan< Coords::CoordSystem >  crs = nullptr  )

static

mkDepthPosition()

static TargetInfo* Table::TargetInfo::mkDepthPosition ( bool  isreq, bool  withunits = true  )

inlinestatic

mkHorPosition()

static TargetInfo* Table::TargetInfo::mkHorPosition ( bool  isreq, bool  wic = true, bool  wll = false, bool  wcrs = true, ConstRefMan< Coords::CoordSystem >  crs = nullptr  )

static

form(0)=(X,Y), form(1)=inl/crl, form(1/2)=long/lat

mkTimePosition()

static TargetInfo* Table::TargetInfo::mkTimePosition ( bool  isreq, bool  withunits = true  )

inlinestatic

mkZPos()

static TargetInfo* Table::TargetInfo::mkZPos ( bool  , bool  wu = false, int  zopt = 0  )

staticprotected

mkZPosition()

static TargetInfo* Table::TargetInfo::mkZPosition ( bool  isreq, bool  withunits = true  )

inlinestatic

needsConversion()

bool Table::TargetInfo::needsConversion

(

)

const

nrForms()

int Table::TargetInfo::nrForms ( ) const

inline

propertyType()

Mnemonic::StdType Table::TargetInfo::propertyType ( ) const

inline

setPropertyType()

void Table::TargetInfo::setPropertyType ( Mnemonic::StdType  p )

inline

sKeyInlCrl()

static const char* Table::TargetInfo::sKeyInlCrl ( )

static

sKeyLatLong()

static const char* Table::TargetInfo::sKeyLatLong ( )

static

sKeyXY()

static const char* Table::TargetInfo::sKeyXY ( )

static

usePar()

void Table::TargetInfo::usePar

(

const IOPar &

)

Member Data Documentation

forms_

ObjectSet<Form> Table::TargetInfo::forms_

protected

proptype_

Mnemonic::StdType Table::TargetInfo::proptype_

protected

req_

ReqSpec Table::TargetInfo::req_

protected

selection_

Selection Table::TargetInfo::selection_

mutable