Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Member Functions | Protected Attributes

Table::TargetInfo Class Reference

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

Inheritance diagram for Table::TargetInfo:
NamedObject CallBacker

List of all members.

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, ReqSpec rs=Optional)
 TargetInfo (const char *nm, DataInpSpec *spec, ReqSpec rs=Optional, PropertyRef::StdType p=PropertyRef::Other)
 TargetInfo (const char *nm, const DataInpSpec &spec, ReqSpec rs=Optional, PropertyRef::StdType p=PropertyRef::Other)
 ~TargetInfo ()
TargetInfoadd (const char *nm, DataInpSpec *spec=0)
TargetInfoadd (const char *nm, const DataInpSpec &spec)
TargetInfoadd (Form *frm)
bool isOptional () const
bool isHidden () const
PropertyRef::StdType propertyType () const
void setPropertyType (PropertyRef::StdType p)
int nrForms () const
Formform (int idx)
const Formform (int idx) const
int formNr (const char *formnm) const
void fillPar (IOPar &) const
void usePar (const IOPar &)

Static Public Member Functions

static TargetInfomkHorPosition (bool isreq)
 form(0)=(X,Y), form(1)=inl/crl
static TargetInfomkZPosition (bool isreq, bool withunits=true)
static TargetInfomkDepthPosition (bool isreq, bool withunits=true)
static TargetInfomkTimePosition (bool isreq, bool withunits=true)

Public Attributes

Selection selection_

Static Protected Member Functions

static TargetInfomkPos (bool, bool, bool wu=false, int zopt=0)

Protected Attributes

ReqSpec req_
PropertyRef::StdType proptype_
ObjectSet< Formforms_

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

Table::TargetInfo::TargetInfo ( const char *  nm,
ReqSpec  rs = Optional 
) [inline]
Parameters:
rs Single string
Table::TargetInfo::TargetInfo ( const char *  nm,
DataInpSpec spec,
ReqSpec  rs = Optional,
PropertyRef::StdType  p = PropertyRef::Other 
) [inline]
Table::TargetInfo::TargetInfo ( const char *  nm,
const DataInpSpec spec,
ReqSpec  rs = Optional,
PropertyRef::StdType  p = PropertyRef::Other 
) [inline]
Table::TargetInfo::~TargetInfo (  )  [inline]

Member Function Documentation

TargetInfo& Table::TargetInfo::add ( const char *  nm,
DataInpSpec spec = 0 
) [inline]
TargetInfo& Table::TargetInfo::add ( const char *  nm,
const DataInpSpec spec 
) [inline]
TargetInfo& Table::TargetInfo::add ( Form frm  )  [inline]
void Table::TargetInfo::fillPar ( IOPar  )  const
Form& Table::TargetInfo::form ( int  idx  )  [inline]
const Form& Table::TargetInfo::form ( int  idx  )  const [inline]
int Table::TargetInfo::formNr ( const char *  formnm  )  const [inline]
bool Table::TargetInfo::isHidden (  )  const [inline]
bool Table::TargetInfo::isOptional (  )  const [inline]
static TargetInfo* Table::TargetInfo::mkDepthPosition ( bool  isreq,
bool  withunits = true 
) [inline, static]
static TargetInfo* Table::TargetInfo::mkHorPosition ( bool  isreq  )  [inline, static]

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

static TargetInfo* Table::TargetInfo::mkPos ( bool  ,
bool  ,
bool  wu = false,
int  zopt = 0 
) [static, protected]
static TargetInfo* Table::TargetInfo::mkTimePosition ( bool  isreq,
bool  withunits = true 
) [inline, static]
static TargetInfo* Table::TargetInfo::mkZPosition ( bool  isreq,
bool  withunits = true 
) [inline, static]
int Table::TargetInfo::nrForms (  )  const [inline]
PropertyRef::StdType Table::TargetInfo::propertyType (  )  const [inline]
void Table::TargetInfo::setPropertyType ( PropertyRef::StdType  p  )  [inline]
void Table::TargetInfo::usePar ( const IOPar  ) 

Member Data Documentation