casacore
|
Class representing a scalar UDF in select expression. More...
#include <ExprUDFNode.h>
Public Member Functions | |
TableExprUDFNode (UDFBase *udf, const Table &, const TableExprNodeSet &source) | |
Constructor. More... | |
virtual | ~TableExprUDFNode () |
Destructor. More... | |
Bool | isAggregate () const |
Is the UDF an aggregate function? More... | |
virtual void | getAggrNodes (std::vector< TableExprNodeRep *> &aggr) |
Get the nodes representing an aggregate function. More... | |
virtual void | getColumnNodes (std::vector< TableExprNodeRep * > &cols) |
Get the nodes representing a table column. More... | |
virtual void | disableApplySelection () |
Do not apply the selection. More... | |
virtual void | applySelection (const Vector< uInt > &rownrs) |
If needed, let the UDF re-create column objects for a selection of rows. More... | |
CountedPtr< TableExprGroupFuncBase > | makeGroupAggrFunc () |
UDFs do not need a TableExprGroupFuncBase, so TableExprGroupNull is returned. More... | |
virtual Bool | getBool (const TableExprId &id) |
Functions to get the desired result of a function. More... | |
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) |
![]() | |
TableExprNodeMulti (NodeDataType, ValueType, OperType, const TableExprNodeRep &source) | |
Constructor. More... | |
virtual | ~TableExprNodeMulti () |
Destructor. More... | |
virtual void | show (ostream &, uInt indent) const |
Show the expression tree. More... | |
virtual void | getColumnNodes (std::vector< TableExprNodeRep *> &cols) |
Get the nodes representing a table column. More... | |
const std::vector< TENShPtr > & | getChildren () const |
Get the child nodes. More... | |
![]() | |
TableExprNodeRep (NodeDataType, ValueType, OperType, ArgType, ExprType, Int ndim, const IPosition &shape, const Table &table) | |
Construct a node. More... | |
TableExprNodeRep (NodeDataType, ValueType, OperType, const Table &) | |
This constructor is called from the derived TableExprNodeRep. More... | |
TableExprNodeRep (const TableExprNodeRep &) | |
Copy constructor. More... | |
virtual | ~TableExprNodeRep () |
The destructor deletes all the underlying TableExprNode objects. More... | |
virtual Double | getUnitFactor () const |
Get the unit conversion factor. More... | |
void | checkAggrFuncs () |
Throw an exception if an aggregate function is used in the expression node or its children. More... | |
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). More... | |
virtual MArray< Bool > | getArrayBool (const TableExprId &id) |
Get an array value for this node in the given row. More... | |
virtual MArray< Int64 > | getArrayInt (const TableExprId &id) |
virtual MArray< Double > | getArrayDouble (const TableExprId &id) |
virtual MArray< DComplex > | getArrayDComplex (const TableExprId &id) |
virtual MArray< String > | getArrayString (const TableExprId &id) |
virtual MArray< MVTime > | getArrayDate (const TableExprId &id) |
void | get (const TableExprId &id, Bool &value) |
General get functions for template purposes. More... | |
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< Bool > | getBoolAS (const TableExprId &id) |
Get a value as an array, even it it is a scalar. More... | |
MArray< Int64 > | getIntAS (const TableExprId &id) |
MArray< Double > | getDoubleAS (const TableExprId &id) |
MArray< DComplex > | getDComplexAS (const TableExprId &id) |
MArray< String > | getStringAS (const TableExprId &id) |
MArray< MVTime > | getDateAS (const TableExprId &id) |
virtual Bool | hasBool (const TableExprId &id, Bool value) |
Does a value occur in an array or set? The default implementation tests if it is in an array. More... | |
virtual Bool | hasInt (const TableExprId &id, Int64 value) |
virtual Bool | hasDouble (const TableExprId &id, Double value) |
virtual Bool | hasDComplex (const TableExprId &id, const DComplex &value) |
virtual Bool | hasString (const TableExprId &id, const String &value) |
virtual Bool | hasDate (const TableExprId &id, const MVTime &value) |
virtual MArray< Bool > | hasArrayBool (const TableExprId &id, const MArray< Bool > &value) |
virtual MArray< Bool > | hasArrayInt (const TableExprId &id, const MArray< Int64 > &value) |
virtual MArray< Bool > | hasArrayDouble (const TableExprId &id, const MArray< Double > &value) |
virtual MArray< Bool > | hasArrayDComplex (const TableExprId &id, const MArray< DComplex > &value) |
virtual MArray< Bool > | hasArrayString (const TableExprId &id, const MArray< String > &value) |
virtual MArray< Bool > | hasArrayDate (const TableExprId &id, const MArray< MVTime > &value) |
uInt | nrow () const |
Get the number of rows in the table associated with this expression. More... | |
virtual Bool | getColumnDataType (DataType &) const |
Get the data type of the column. More... | |
virtual Array< Bool > | getColumnBool (const Vector< uInt > &rownrs) |
Get the value of the expression evaluated for the entire column. More... | |
virtual Array< uChar > | getColumnuChar (const Vector< uInt > &rownrs) |
virtual Array< Short > | getColumnShort (const Vector< uInt > &rownrs) |
virtual Array< uShort > | getColumnuShort (const Vector< uInt > &rownrs) |
virtual Array< Int > | getColumnInt (const Vector< uInt > &rownrs) |
virtual Array< uInt > | getColumnuInt (const Vector< uInt > &rownrs) |
virtual Array< Float > | getColumnFloat (const Vector< uInt > &rownrs) |
virtual Array< Double > | getColumnDouble (const Vector< uInt > &rownrs) |
virtual Array< Complex > | getColumnComplex (const Vector< uInt > &rownrs) |
virtual Array< DComplex > | getColumnDComplex (const Vector< uInt > &rownrs) |
virtual Array< String > | getColumnString (const Vector< uInt > &rownrs) |
virtual void | ranges (Block< TableExprRange > &) |
Convert the tree to a number of range vectors which at least select the same things. More... | |
NodeDataType | dataType () const |
Get the data type of the derived TableExprNode object. More... | |
Bool | isReal () const |
Is the data type real (i.e., integer or double)? More... | |
ValueType | valueType () const |
Get the value type. More... | |
void | setValueType (ValueType vtype) |
Set the value type. More... | |
OperType | operType () const |
Get the operator type. More... | |
ExprType | exprType () const |
Get the expression type. More... | |
Bool | isConstant () const |
Is the expression a constant? More... | |
const Unit & | unit () const |
Get the unit. More... | |
void | setUnit (const Unit &unit) |
Set the unit. More... | |
const Record & | attributes () const |
Get the attributes. More... | |
void | setAttributes (const Record &) |
Set the attributes. More... | |
Int | ndim () const |
Get the fixed dimensionality (same for all rows). More... | |
const IPosition & | shape () const |
Get the fixed shape (same for all rows). More... | |
const IPosition & | shape (const TableExprId &id) |
Get the shape for the given row. More... | |
virtual Bool | isDefined (const TableExprId &id) |
Is the value in the given row defined? The default implementation returns True. More... | |
Table & | table () |
Get table. More... | |
const Table & | table () const |
virtual void | adaptSetUnits (const Unit &) |
Let a set node convert itself to the given unit. More... | |
Private Attributes | |
UDFBase * | itsUDF |
Additional Inherited Members | |
![]() | |
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 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. More... | |
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. More... | |
![]() | |
static TENShPtr | replaceConstNode (const TENShPtr &node) |
Replace a node with a constant expression by node with its value. More... | |
static void | createRange (Block< TableExprRange > &, TableExprNodeColumn *, Double start, Double end) |
Create a range object from a column and an interval. More... | |
static void | createRange (Block< TableExprRange > &) |
Create a empty range object. More... | |
static String | typeString (NodeDataType) |
Convert a NodeDataType to a string. More... | |
static String | typeString (ValueType) |
Convert a ValueType to a string. More... | |
![]() | |
virtual const IPosition & | getShape (const TableExprId &id) |
Get the shape for the given row. More... | |
virtual void | convertConstChild () |
If one of the children is a constant, convert its data type to that of the other operand (if appropriate). More... | |
void | checkTablePtr (const TENShPtr &node) |
Check if this node uses the same table pointer. More... | |
void | fillExprType (const TENShPtr &node) |
Set expression type to Variable if node is Variable. More... | |
![]() | |
static void | checkTablePtr (Table &table, const TENShPtr &node) |
static void | fillExprType (ExprType &, const TENShPtr &node) |
static TENShPtr | convertNode (const TENShPtr &thisNode, Bool convertConstType) |
If the node is constant, it is evaluated and replaced by the appropriate TableExprNodeConst object. More... | |
![]() | |
std::vector< TENShPtr > | operands_p |
![]() | |
Table | table_p |
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 |
Class representing a scalar UDF in select expression.
Internal
This class represents a function in a table select tree. The rownumber
function is represented by class TableExprNodeRownr . The rowid
function is represented by class TableExprNodeRowid . The rand
function is represented by class TableExprNodeRandom .
When one wants to add a function to the table selection grammar, the following has to be done:
Definition at line 75 of file ExprUDFNode.h.
casacore::TableExprUDFNode::TableExprUDFNode | ( | UDFBase * | udf, |
const Table & | , | ||
const TableExprNodeSet & | source | ||
) |
Constructor.
|
virtual |
Destructor.
If needed, let the UDF re-create column objects for a selection of rows.
It calls the function recreateColumnObjects.
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Do not apply the selection.
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Get the nodes representing an aggregate function.
Reimplemented from casacore::TableExprNodeMulti.
Referenced by isAggregate().
|
virtual |
Functions to get the desired result of a function.
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Get the nodes representing a table column.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
virtual |
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
inline |
Is the UDF an aggregate function?
Definition at line 87 of file ExprUDFNode.h.
References applySelection(), disableApplySelection(), getAggrNodes(), getBool(), getColumnNodes(), getDate(), getDComplex(), getDouble(), getInt(), getRegex(), getString(), casacore::UDFBase::isAggregate(), itsUDF, and makeGroupAggrFunc().
|
virtual |
UDFs do not need a TableExprGroupFuncBase, so TableExprGroupNull is returned.
Reimplemented from casacore::TableExprNodeRep.
Referenced by isAggregate().
|
private |
Definition at line 119 of file ExprUDFNode.h.
Referenced by isAggregate().