casacore
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
casacore::TableExprNodeMulti Class Reference

Abstract base class for a node having multiple child nodes. More...

#include <ExprNodeRep.h>

Public Member Functions

 TableExprNodeMulti (NodeDataType, ValueType, OperType, const TableExprNodeRep &source)
 Constructor.
 
 ~TableExprNodeMulti () override=default
 Destructor.
 
void show (ostream &, uInt indent) const override
 Show the expression tree.
 
void flattenTree (std::vector< TableExprNodeRep * > &) override
 Flatten the node tree by adding the node and its children to the vector.
 
const std::vector< TENShPtr > & getChildren () const
 Get the child nodes.
 
- 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.
 
virtual void adaptSetUnits (const Unit &)
 Let a set node convert itself to the given unit.
 

Static Public Member Functions

static uInt checkNumOfArg (uInt low, uInt high, const std::vector< TENShPtr > &nodes)
 Check number of arguments low <= number_of_args <= high It throws an exception if wrong number of arguments.
 
static NodeDataType checkDT (Block< Int > &dtypeOper, NodeDataType dtIn, NodeDataType dtOut, const std::vector< TENShPtr > &nodes, Bool dateConv=True)
 Check datatype of nodes and return output type.
 
- 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.
 

Protected Attributes

std::vector< TENShPtroperands_p
 
- 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...
 
- 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.
 
- 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

Abstract base class for a node having multiple child nodes.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

TableExprNodeMulti is a node in the table expression tree which can have MULTIple child nodes.

Synopsis

TableExprNodeMulti is the abstract base class for all nodes in a table expression tree using multiple operands. It is used as the base class for the node classes representing functions, sets, indices, etc..

Motivation

This class contains the common functionality for the classes representing a node with multiple operands.

Definition at line 680 of file ExprNodeRep.h.

Constructor & Destructor Documentation

◆ TableExprNodeMulti()

casacore::TableExprNodeMulti::TableExprNodeMulti ( NodeDataType  ,
ValueType  ,
OperType  ,
const TableExprNodeRep source 
)

Constructor.

◆ ~TableExprNodeMulti()

casacore::TableExprNodeMulti::~TableExprNodeMulti ( )
overridedefault

Destructor.

Member Function Documentation

◆ checkDT()

static NodeDataType casacore::TableExprNodeMulti::checkDT ( Block< Int > &  dtypeOper,
NodeDataType  dtIn,
NodeDataType  dtOut,
const std::vector< TENShPtr > &  nodes,
Bool  dateConv = True 
)
static

Check datatype of nodes and return output type.

It also sets the expected data type of the operands (from dtIn). Conversion of Int,Double.String to Date is by default possible.

◆ checkNumOfArg()

static uInt casacore::TableExprNodeMulti::checkNumOfArg ( uInt  low,
uInt  high,
const std::vector< TENShPtr > &  nodes 
)
static

Check number of arguments low <= number_of_args <= high It throws an exception if wrong number of arguments.

◆ flattenTree()

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

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

Reimplemented from casacore::TableExprNodeRep.

Reimplemented in casacore::TableExprUDFNode.

◆ getChildren()

const std::vector< TENShPtr > & casacore::TableExprNodeMulti::getChildren ( ) const
inline

Get the child nodes.

Definition at line 703 of file ExprNodeRep.h.

References operands_p.

◆ show()

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

Show the expression tree.

Reimplemented from casacore::TableExprNodeRep.

Member Data Documentation

◆ operands_p

std::vector<TENShPtr> casacore::TableExprNodeMulti::operands_p
protected

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