casacore
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
casacore::TableExprNodeSetElemBase Class Referenceabstract

More...

#include <ExprNodeSetElem.h>

Public Member Functions

 TableExprNodeSetElemBase (NodeDataType=NTDouble)
 Constructor to initialize the parent.
 
virtual ~TableExprNodeSetElemBase ()=default
 
TableExprNodeSetElemBaseoperator= (const TableExprNodeSetElemBase &)=delete
 A copy of a TableExprNodeSetElem cannot be made.
 
void show (ostream &os, uInt indent) const override
 Show the node.
 
virtual void flattenTree (std::vector< TableExprNodeRep * > &) override
 Flatten the node tree by adding the node and its children to the vector.
 
virtual Bool isDiscrete () const
 Is it a discrete set element.
 
virtual Bool isSingle () const
 Is a single value given? Default implementation returns False.
 
virtual Bool isLeftClosed () const
 Is the interval left or right closed? Default implementation returns False.
 
virtual Bool isRightClosed () const
 
virtual Bool isMidWidth () const
 Is the interval given as mid-width? Default implementation returns False.
 
const TENShPtrstart () const
 Get the start, end or increment expression.
 
const TENShPtrend () const
 
const TENShPtrincrement () const
 
virtual void fillVector (Vector< Bool > &vec, Int64 &cnt, const TableExprId &id) const
 Fill a vector with the value(s) from this element by appending them at the end of the vector; the end is given by argument cnt which gets incremented with the number of values appended.
 
virtual void fillVector (Vector< Int64 > &vec, Int64 &cnt, const TableExprId &id) const
 
virtual void fillVector (Vector< Double > &vec, Int64 &cnt, const TableExprId &id) const
 
virtual void fillVector (Vector< DComplex > &vec, Int64 &cnt, const TableExprId &id) const
 
virtual void fillVector (Vector< String > &vec, Int64 &cnt, const TableExprId &id) const
 
virtual void fillVector (Vector< MVTime > &vec, Int64 &cnt, const TableExprId &id) const
 
virtual void matchBool (Bool *match, const Bool *value, size_t nval, const TableExprId &id) const
 Set a flag in the match output array if the corresponding element in the value array is included in this set element.
 
virtual void matchInt (Bool *match, const Int64 *value, size_t nval, const TableExprId &id) const
 
virtual void matchDouble (Bool *match, const Double *value, size_t nval, const TableExprId &id) const
 
virtual void matchDComplex (Bool *match, const DComplex *value, size_t nval, const TableExprId &id) const
 
virtual void matchString (Bool *match, const String *value, size_t nval, const TableExprId &id) const
 
virtual void matchDate (Bool *match, const MVTime *value, size_t nval, const TableExprId &id) const
 
virtual TENSEBShPtr evaluate (const TableExprId &id) const =0
 Evaluate the element for the given row and construct a new (constant) element from it.
 
void setExprType ()
 Set the expression type (Variable or Constant) depending on the children.
 
void adaptSetUnits (const Unit &) override
 Let a set node convert itself to the given unit.
 
void getStart (const TableExprId &id, Double &) const
 Get the start or end value of a Double or DateTime interval.
 
void getEnd (const TableExprId &id, Double &) const
 
void getStart (const TableExprId &id, String &) const
 Get the start or end value of a String interval.
 
void getEnd (const TableExprId &id, String &) const
 
- Public Member Functions inherited from casacore::TableExprNodeRep
 TableExprNodeRep (NodeDataType, ValueType, OperType, ArgType, ExprType, Int ndim, const IPosition &shape)
 Construct a node.
 
 TableExprNodeRep (NodeDataType, ValueType, OperType, ExprType)
 This constructor is called from the derived TableExprNodeRep.
 
 TableExprNodeRep (const TableExprNodeRep &)=default
 Copy constructor.
 
TableExprNodeRepoperator= (const TableExprNodeRep &)=delete
 Assign to a TableExprNodeRep cannot be done.
 
virtual ~TableExprNodeRep ()=default
 The destructor deletes all the underlying TableExprNode objects.
 
virtual Bool isAggregate () const
 Is the node an aggegation node.
 
virtual TableExprInfo getTableInfo () const
 Get the table info.
 
virtual void optimize ()
 Try to optimize the node (meant for the right hand of the IN operator).
 
virtual void disableApplySelection ()
 Do not apply the selection.
 
virtual void applySelection (const Vector< rownr_t > &rownrs)
 Re-create the column object for a selection of rows.
 
virtual Double getUnitFactor () const
 Get the unit conversion factor.
 
virtual std::shared_ptr< TableExprGroupFuncBasemakeGroupAggrFunc ()
 Create the correct immediate aggregate function object.
 
virtual Bool isLazyAggregate () const
 Is the aggregate function a lazy or an immediate one? The default implementation returns True (because all UDF aggregate functions have to be lazy).
 
virtual Bool getBool (const TableExprId &id)
 Get a scalar value for this node in the given row.
 
virtual Int64 getInt (const TableExprId &id)
 
virtual Double getDouble (const TableExprId &id)
 
virtual DComplex getDComplex (const TableExprId &id)
 
virtual String getString (const TableExprId &id)
 
virtual TaqlRegex getRegex (const TableExprId &id)
 
virtual MVTime getDate (const TableExprId &id)
 
virtual MArray< BoolgetArrayBool (const TableExprId &id)
 Get an array value for this node in the given row.
 
virtual MArray< Int64getArrayInt (const TableExprId &id)
 
virtual MArray< DoublegetArrayDouble (const TableExprId &id)
 
virtual MArray< DComplex > getArrayDComplex (const TableExprId &id)
 
virtual MArray< StringgetArrayString (const TableExprId &id)
 
virtual MArray< MVTimegetArrayDate (const TableExprId &id)
 
void get (const TableExprId &id, Bool &value)
 General get functions for template purposes.
 
void get (const TableExprId &id, Int64 &value)
 
void get (const TableExprId &id, Double &value)
 
void get (const TableExprId &id, DComplex &value)
 
void get (const TableExprId &id, MVTime &value)
 
void get (const TableExprId &id, String &value)
 
void get (const TableExprId &id, MArray< Bool > &value)
 
void get (const TableExprId &id, MArray< Int64 > &value)
 
void get (const TableExprId &id, MArray< Double > &value)
 
void get (const TableExprId &id, MArray< DComplex > &value)
 
void get (const TableExprId &id, MArray< MVTime > &value)
 
void get (const TableExprId &id, MArray< String > &value)
 
MArray< BoolgetBoolAS (const TableExprId &id)
 Get a value as an array, even it it is a scalar.
 
MArray< Int64getIntAS (const TableExprId &id)
 
MArray< DoublegetDoubleAS (const TableExprId &id)
 
MArray< DComplex > getDComplexAS (const TableExprId &id)
 
MArray< StringgetStringAS (const TableExprId &id)
 
MArray< MVTimegetDateAS (const TableExprId &id)
 
virtual Bool contains (const TableExprId &id, Bool value)
 Does a set or array contain the value? The default implementation assumes the set is a single scalar, thus tests if it is equal to the given value.
 
virtual Bool contains (const TableExprId &id, Int64 value)
 
virtual Bool contains (const TableExprId &id, Double value)
 
virtual Bool contains (const TableExprId &id, DComplex value)
 
virtual Bool contains (const TableExprId &id, String value)
 
virtual Bool contains (const TableExprId &id, MVTime value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< Bool > &value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< Int64 > &value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< Double > &value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< DComplex > &value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< String > &value)
 
virtual MArray< Boolcontains (const TableExprId &id, const MArray< MVTime > &value)
 
rownr_t nrow ()
 Get the number of rows in the table associated with this expression.
 
virtual Bool getColumnDataType (DataType &) const
 Get the data type of the column.
 
virtual Array< BoolgetColumnBool (const Vector< rownr_t > &rownrs)
 Get the value of the expression evaluated for the entire column.
 
virtual Array< uChargetColumnuChar (const Vector< rownr_t > &rownrs)
 
virtual Array< ShortgetColumnShort (const Vector< rownr_t > &rownrs)
 
virtual Array< uShortgetColumnuShort (const Vector< rownr_t > &rownrs)
 
virtual Array< IntgetColumnInt (const Vector< rownr_t > &rownrs)
 
virtual Array< uIntgetColumnuInt (const Vector< rownr_t > &rownrs)
 
virtual Array< Int64getColumnInt64 (const Vector< rownr_t > &rownrs)
 
virtual Array< FloatgetColumnFloat (const Vector< rownr_t > &rownrs)
 
virtual Array< DoublegetColumnDouble (const Vector< rownr_t > &rownrs)
 
virtual Array< Complex > getColumnComplex (const Vector< rownr_t > &rownrs)
 
virtual Array< DComplex > getColumnDComplex (const Vector< rownr_t > &rownrs)
 
virtual Array< StringgetColumnString (const Vector< rownr_t > &rownrs)
 
virtual void ranges (Block< TableExprRange > &)
 Convert the tree to a number of range vectors which at least select the same things.
 
NodeDataType dataType () const
 Get the data type of the derived TableExprNode object.
 
Bool isReal () const
 Is the data type real (i.e., integer or double)?
 
ValueType valueType () const
 Get the value type.
 
void setValueType (ValueType vtype)
 Set the value type.
 
OperType operType () const
 Get the operator type.
 
ExprType exprType () const
 Get the expression type.
 
Bool isConstant () const
 Is the expression a constant?
 
const Unitunit () const
 Get the unit.
 
void setUnit (const Unit &unit)
 Set the unit.
 
const Recordattributes () const
 Get the attributes.
 
void setAttributes (const Record &)
 Set the attributes.
 
Int ndim () const
 Get the fixed dimensionality (same for all rows).
 
const IPositionshape () const
 Get the fixed shape (same for all rows).
 
const IPositionshape (const TableExprId &id)
 Get the shape for the given row.
 
virtual Bool isDefined (const TableExprId &id)
 Is the value in the given row defined? The default implementation returns True.
 

Protected Member Functions

TENShPtr evalExpr (const TENShPtr &expr, const TableExprId &id) const
 Evaluate the expression for the given row id.
 
- Protected Member Functions inherited from casacore::TableExprNodeRep
virtual const IPositiongetShape (const TableExprId &id)
 Get the shape for the given row.
 
void fillExprType (const TableExprNodeRep *node)
 Set expression type to Variable if node is Variable.
 

Protected Attributes

TENShPtr itsStart
 
TENShPtr itsEnd
 
TENShPtr itsIncr
 
- Protected Attributes inherited from casacore::TableExprNodeRep
NodeDataType dtype_p
 
ValueType vtype_p
 
OperType optype_p
 
ArgType argtype_p
 
ExprType exprtype_p
 
Int ndim_p
 
IPosition shape_p
 
Unit unit_p
 
Record attributes_p
 

Additional Inherited Members

- Public Types inherited from casacore::TableExprNodeRep
enum  NodeDataType {
  NTBool ,
  NTInt ,
  NTDouble ,
  NTComplex ,
  NTString ,
  NTRegex ,
  NTDate ,
  NTReal ,
  NTDouCom ,
  NTNumeric ,
  NTAny
}
 Define the data types of a node. More...
 
enum  ValueType {
  VTScalar ,
  VTArray ,
  VTRecord ,
  VTSetElem ,
  VTSet ,
  VTIndex
}
 Define the value types. More...
 
enum  OperType {
  OtPlus ,
  OtMinus ,
  OtTimes ,
  OtDivide ,
  OtModulo ,
  OtBitAnd ,
  OtBitOr ,
  OtBitXor ,
  OtBitNegate ,
  OtEQ ,
  OtGE ,
  OtGT ,
  OtNE ,
  OtIN ,
  OtAND ,
  OtOR ,
  OtNOT ,
  OtMIN ,
  OtColumn ,
  OtField ,
  OtLiteral ,
  OtFunc ,
  OtSlice ,
  OtUndef ,
  OtRownr ,
  OtRandom
}
 Define the operator types. More...
 
enum  ArgType {
  NoArr ,
  ArrArr ,
  ArrSca ,
  ScaArr
}
 Define the value types of the 2 arguments when arrays are involved. More...
 
enum  ExprType {
  Constant ,
  Variable
}
 Define (sub-)expression type. More...
 
- Static Public Member Functions inherited from casacore::TableExprNodeRep
static TENShPtr replaceConstNode (const TENShPtr &node)
 Replace a node with a constant expression by node with its value.
 
static void createRange (Block< TableExprRange > &, TableExprNodeColumn *, Double start, Double end)
 Create a range object from a column and an interval.
 
static void createRange (Block< TableExprRange > &)
 Create a empty range object.
 
static String typeString (NodeDataType)
 Convert a NodeDataType to a string.
 
static String typeString (ValueType)
 Convert a ValueType to a string.
 
- Static Protected Member Functions inherited from casacore::TableExprNodeRep
static TENShPtr convertNode (const TENShPtr &thisNode, Bool convertConstType)
 If the node is constant, it is evaluated and replaced by the appropriate TableExprNodeConst object.
 

Detailed Description

Base class for the classes defining set element

Intended use:

Internal

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Prerequisite

Synopsis

This class is used to assemble the table expression nodes representing an element in a set. There are various types of elements such as a single value, discrete range and continuous interval.
The base class holds the possible start, end and increment value of an element. It also has functions telling the overall expression which columns and aggregate functions are used by an element.

Definition at line 69 of file ExprNodeSetElem.h.

Constructor & Destructor Documentation

◆ TableExprNodeSetElemBase()

casacore::TableExprNodeSetElemBase::TableExprNodeSetElemBase ( NodeDataType  = NTDouble)
explicit

Constructor to initialize the parent.

◆ ~TableExprNodeSetElemBase()

virtual casacore::TableExprNodeSetElemBase::~TableExprNodeSetElemBase ( )
virtualdefault

Member Function Documentation

◆ adaptSetUnits()

void casacore::TableExprNodeSetElemBase::adaptSetUnits ( const Unit )
overridevirtual

Let a set node convert itself to the given unit.

Reimplemented from casacore::TableExprNodeRep.

◆ end()

const TENShPtr & casacore::TableExprNodeSetElemBase::end ( ) const
inline

Definition at line 111 of file ExprNodeSetElem.h.

References itsEnd.

◆ evalExpr()

TENShPtr casacore::TableExprNodeSetElemBase::evalExpr ( const TENShPtr expr,
const TableExprId id 
) const
protected

Evaluate the expression for the given row id.

◆ evaluate()

virtual TENSEBShPtr casacore::TableExprNodeSetElemBase::evaluate ( const TableExprId id) const
pure virtual

Evaluate the element for the given row and construct a new (constant) element from it.

This is used by the system to implement a set in a GIVING clause.

Implemented in casacore::TableExprNodeSetElemSingle, casacore::TableExprNodeSetElemDiscrete, casacore::TableExprNodeSetElemCont, and casacore::TableExprNodeSetElemMidWidth.

◆ fillVector() [1/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< Bool > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

Fill a vector with the value(s) from this element by appending them at the end of the vector; the end is given by argument cnt which gets incremented with the number of values appended.

This is used by the system to convert a set to a vector.

Reimplemented in casacore::TableExprNodeSetElemSingle.

◆ fillVector() [2/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< DComplex > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

◆ fillVector() [3/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< Double > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

◆ fillVector() [4/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< Int64 > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

◆ fillVector() [5/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< MVTime > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

◆ fillVector() [6/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector ( Vector< String > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual

◆ flattenTree()

virtual void casacore::TableExprNodeSetElemBase::flattenTree ( std::vector< TableExprNodeRep * > &  )
overridevirtual

Flatten the node tree by adding the node and its children to the vector.

Reimplemented from casacore::TableExprNodeRep.

◆ getEnd() [1/2]

void casacore::TableExprNodeSetElemBase::getEnd ( const TableExprId id,
Double  
) const

◆ getEnd() [2/2]

void casacore::TableExprNodeSetElemBase::getEnd ( const TableExprId id,
String  
) const

◆ getStart() [1/2]

void casacore::TableExprNodeSetElemBase::getStart ( const TableExprId id,
Double  
) const

Get the start or end value of a Double or DateTime interval.

◆ getStart() [2/2]

void casacore::TableExprNodeSetElemBase::getStart ( const TableExprId id,
String  
) const

Get the start or end value of a String interval.

◆ increment()

const TENShPtr & casacore::TableExprNodeSetElemBase::increment ( ) const
inline

Definition at line 113 of file ExprNodeSetElem.h.

References itsIncr.

◆ isDiscrete()

virtual Bool casacore::TableExprNodeSetElemBase::isDiscrete ( ) const
virtual

Is it a discrete set element.

Default implementation returns False.

Reimplemented in casacore::TableExprNodeSetElemSingle, and casacore::TableExprNodeSetElemDiscrete.

◆ isLeftClosed()

virtual Bool casacore::TableExprNodeSetElemBase::isLeftClosed ( ) const
virtual

Is the interval left or right closed? Default implementation returns False.

Reimplemented in casacore::TableExprNodeSetElemCont.

◆ isMidWidth()

virtual Bool casacore::TableExprNodeSetElemBase::isMidWidth ( ) const
virtual

Is the interval given as mid-width? Default implementation returns False.

Reimplemented in casacore::TableExprNodeSetElemMidWidth.

◆ isRightClosed()

virtual Bool casacore::TableExprNodeSetElemBase::isRightClosed ( ) const
virtual

◆ isSingle()

virtual Bool casacore::TableExprNodeSetElemBase::isSingle ( ) const
virtual

Is a single value given? Default implementation returns False.

Reimplemented in casacore::TableExprNodeSetElemSingle.

◆ matchBool()

virtual void casacore::TableExprNodeSetElemBase::matchBool ( Bool match,
const Bool value,
size_t  nval,
const TableExprId id 
) const
virtual

Set a flag in the match output array if the corresponding element in the value array is included in this set element.

This is used by the system to implement the IN operator.
Note that it does NOT set match values to False; it is assumed they are initialized that way.

Reimplemented in casacore::TableExprNodeSetElemSingle.

◆ matchDate()

virtual void casacore::TableExprNodeSetElemBase::matchDate ( Bool match,
const MVTime value,
size_t  nval,
const TableExprId id 
) const
virtual

◆ matchDComplex()

virtual void casacore::TableExprNodeSetElemBase::matchDComplex ( Bool match,
const DComplex *  value,
size_t  nval,
const TableExprId id 
) const
virtual

◆ matchDouble()

virtual void casacore::TableExprNodeSetElemBase::matchDouble ( Bool match,
const Double value,
size_t  nval,
const TableExprId id 
) const
virtual

◆ matchInt()

virtual void casacore::TableExprNodeSetElemBase::matchInt ( Bool match,
const Int64 value,
size_t  nval,
const TableExprId id 
) const
virtual

◆ matchString()

virtual void casacore::TableExprNodeSetElemBase::matchString ( Bool match,
const String value,
size_t  nval,
const TableExprId id 
) const
virtual

◆ operator=()

TableExprNodeSetElemBase & casacore::TableExprNodeSetElemBase::operator= ( const TableExprNodeSetElemBase )
delete

A copy of a TableExprNodeSetElem cannot be made.

◆ setExprType()

void casacore::TableExprNodeSetElemBase::setExprType ( )

Set the expression type (Variable or Constant) depending on the children.

◆ show()

void casacore::TableExprNodeSetElemBase::show ( ostream &  os,
uInt  indent 
) const
overridevirtual

Show the node.

Reimplemented from casacore::TableExprNodeRep.

◆ start()

const TENShPtr & casacore::TableExprNodeSetElemBase::start ( ) const
inline

Get the start, end or increment expression.

Note that the shared pointer returned can be null indicating that a value was not given.

Definition at line 109 of file ExprNodeSetElem.h.

References itsStart.

Member Data Documentation

◆ itsEnd

TENShPtr casacore::TableExprNodeSetElemBase::itsEnd
protected

Definition at line 187 of file ExprNodeSetElem.h.

Referenced by end().

◆ itsIncr

TENShPtr casacore::TableExprNodeSetElemBase::itsIncr
protected

Definition at line 188 of file ExprNodeSetElem.h.

Referenced by increment().

◆ itsStart

TENShPtr casacore::TableExprNodeSetElemBase::itsStart
protected

Definition at line 186 of file ExprNodeSetElem.h.

Referenced by start().


The documentation for this class was generated from the following file: