casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casacore::TableExprUDFNode Class Reference

Class representing a scalar UDF in select expression. More...

#include <ExprUDFNode.h>

Inheritance diagram for casacore::TableExprUDFNode:
casacore::TableExprNodeMulti casacore::TableExprNodeRep

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)
 
- Public Member Functions inherited from casacore::TableExprNodeMulti
 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...
 
const std::vector< TENShPtr > & getChildren () const
 Get the child nodes. More...
 
- Public Member Functions inherited from casacore::TableExprNodeRep
 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< BoolgetArrayBool (const TableExprId &id)
 Get an array value for this node in the given row. More...
 
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. 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< BoolgetBoolAS (const TableExprId &id)
 Get a value as an array, even it it is a scalar. More...
 
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 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< BoolhasArrayBool (const TableExprId &id, const MArray< Bool > &value)
 
virtual MArray< BoolhasArrayInt (const TableExprId &id, const MArray< Int64 > &value)
 
virtual MArray< BoolhasArrayDouble (const TableExprId &id, const MArray< Double > &value)
 
virtual MArray< BoolhasArrayDComplex (const TableExprId &id, const MArray< DComplex > &value)
 
virtual MArray< BoolhasArrayString (const TableExprId &id, const MArray< String > &value)
 
virtual MArray< BoolhasArrayDate (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< BoolgetColumnBool (const Vector< uInt > &rownrs)
 Get the value of the expression evaluated for the entire column. More...
 
virtual Array< uChargetColumnuChar (const Vector< uInt > &rownrs)
 
virtual Array< ShortgetColumnShort (const Vector< uInt > &rownrs)
 
virtual Array< uShortgetColumnuShort (const Vector< uInt > &rownrs)
 
virtual Array< IntgetColumnInt (const Vector< uInt > &rownrs)
 
virtual Array< uIntgetColumnuInt (const Vector< uInt > &rownrs)
 
virtual Array< Int64getColumnInt64 (const Vector< uInt > &rownrs)
 
virtual Array< FloatgetColumnFloat (const Vector< uInt > &rownrs)
 
virtual Array< DoublegetColumnDouble (const Vector< uInt > &rownrs)
 
virtual Array< Complex > getColumnComplex (const Vector< uInt > &rownrs)
 
virtual Array< DComplex > getColumnDComplex (const Vector< uInt > &rownrs)
 
virtual Array< StringgetColumnString (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 Unitunit () const
 Get the unit. More...
 
void setUnit (const Unit &unit)
 Set the unit. More...
 
const Recordattributes () 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 IPositionshape () const
 Get the fixed shape (same for all rows). More...
 
const IPositionshape (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...
 
Tabletable ()
 Get table. More...
 
const Tabletable () const
 
virtual void adaptSetUnits (const Unit &)
 Let a set node convert itself to the given unit. More...
 

Private Attributes

UDFBaseitsUDF
 

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::TableExprNodeMulti
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 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. 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...
 
- Protected Member Functions inherited from casacore::TableExprNodeRep
virtual const IPositiongetShape (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 Protected Member Functions inherited from casacore::TableExprNodeRep
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...
 
- Protected Attributes inherited from casacore::TableExprNodeMulti
std::vector< TENShPtroperands_p
 
- Protected Attributes inherited from casacore::TableExprNodeRep
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
 

Detailed Description

Class representing a scalar UDF in select expression.

Intended use:

Internal

Review Status

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

Prerequisite

Synopsis

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.

Constructor & Destructor Documentation

casacore::TableExprUDFNode::TableExprUDFNode ( UDFBase udf,
const Table ,
const TableExprNodeSet source 
)

Constructor.

virtual casacore::TableExprUDFNode::~TableExprUDFNode ( )
virtual

Destructor.

Member Function Documentation

virtual void casacore::TableExprUDFNode::applySelection ( const Vector< uInt > &  rownrs)
virtual

If needed, let the UDF re-create column objects for a selection of rows.

It calls the function recreateColumnObjects.

Reimplemented from casacore::TableExprNodeRep.

virtual void casacore::TableExprUDFNode::disableApplySelection ( )
virtual

Do not apply the selection.

Reimplemented from casacore::TableExprNodeRep.

virtual void casacore::TableExprUDFNode::getAggrNodes ( std::vector< TableExprNodeRep * > &  aggr)
virtual

Get the nodes representing an aggregate function.

Reimplemented from casacore::TableExprNodeMulti.

virtual Bool casacore::TableExprUDFNode::getBool ( const TableExprId id)
virtual

Functions to get the desired result of a function.

Reimplemented from casacore::TableExprNodeRep.

virtual void casacore::TableExprUDFNode::getColumnNodes ( std::vector< TableExprNodeRep * > &  cols)
virtual

Get the nodes representing a table column.

Reimplemented from casacore::TableExprNodeMulti.

virtual MVTime casacore::TableExprUDFNode::getDate ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

virtual DComplex casacore::TableExprUDFNode::getDComplex ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

virtual Double casacore::TableExprUDFNode::getDouble ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

virtual Int64 casacore::TableExprUDFNode::getInt ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

virtual TaqlRegex casacore::TableExprUDFNode::getRegex ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

virtual String casacore::TableExprUDFNode::getString ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

Bool casacore::TableExprUDFNode::isAggregate ( ) const
inline

Is the UDF an aggregate function?

Definition at line 87 of file ExprUDFNode.h.

References casacore::UDFBase::isAggregate(), and itsUDF.

CountedPtr<TableExprGroupFuncBase> casacore::TableExprUDFNode::makeGroupAggrFunc ( )
virtual

UDFs do not need a TableExprGroupFuncBase, so TableExprGroupNull is returned.

Reimplemented from casacore::TableExprNodeRep.

Member Data Documentation

UDFBase* casacore::TableExprUDFNode::itsUDF
private

Definition at line 119 of file ExprUDFNode.h.

Referenced by isAggregate().


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