Loading...
Searching...
No Matches
ExprUDFNodeArray.h
Go to the documentation of this file.
//# ExprUDFNodeArray.h: Class representing an array UDF in select expression
//# Copyright (C) 2010
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef TABLES_EXPRUDFNODEARRAY_H
#define TABLES_EXPRUDFNODEARRAY_H
//# Includes
#include <casacore/tables/TaQL/ExprNodeArray.h>
#include <casacore/tables/TaQL/UDFBase.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class TableExprNodeSet;
// <summary>
// Class representing an array UDF in select expression
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto class=TableExprNodeMulti>TableExprNodeMulti</linkto>
// </prerequisite>
// <synopsis>
// This class represents a function in a table select tree.
// The <src>rownumber</src> function is represented by class
// <linkto class=TableExprNodeRownr>TableExprNodeRownr</linkto>.
// The <src>rowid</src> function is represented by class
// <linkto class=TableExprNodeRowid>TableExprNodeRowid</linkto>.
// The <src>rand</src> function is represented by class
// <linkto class=TableExprNodeRandom>TableExprNodeRandom</linkto>.
// <p>
// When one wants to add a function to the table selection grammar,
// the following has to be done:
// <ul>
// <li> Add the function to the enum below.
// <li> Implement the function in the get functions in ExprFuncNode(Array).cc.
// <li> Implement the function in the checkOperands in ExprFuncNode.cc.
// <li> Declare and define the function in ExprNode.h (for C++ binding).
// <li> Add the function to findFunc in TableParse.cc (for TaQL).
// </ul>
// </synopsis>
class TableExprUDFNodeArray: public TableExprNodeArray
{
public:
// Constructor
TableExprUDFNodeArray (const std::shared_ptr<UDFBase>& udf,
const TableExprInfo&,
const TableExprNodeSet& source);
// Destructor
~TableExprUDFNodeArray() override = default;
// Flatten the node tree by adding the node and its children to the vector.
void flattenTree (std::vector<TableExprNodeRep*>&) override;
// Get the table info.
TableExprInfo getTableInfo() const override;
// Do not apply the selection.
void disableApplySelection() override;
// If needed, let the UDF re-create column objects for a selection of rows.
// It calls the function recreateColumnObjects.
void applySelection (const Vector<rownr_t>& rownrs) override;
// UDFs do not need a TableExprGroupFuncBase, so null is returned.
std::shared_ptr<TableExprGroupFuncBase> makeGroupAggrFunc() override;
// Functions to get the desired result of a function
// <group>
MArray<Bool> getArrayBool (const TableExprId& id) override;
MArray<Int64> getArrayInt (const TableExprId& id) override;
MArray<Double> getArrayDouble (const TableExprId& id) override;
MArray<DComplex> getArrayDComplex (const TableExprId& id) override;
MArray<String> getArrayString (const TableExprId& id) override;
MArray<MVTime> getArrayDate (const TableExprId& id) override;
// </group>
private:
TableExprInfo itsTableInfo;
std::shared_ptr<UDFBase> itsUDF;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MArray
Definition MArray.h:68
casacore::TableExprId
Definition TableExprId.h:95
casacore::TableExprInfo
Class to connect a Table and its alias name.
Definition ExprNodeRep.h:125
casacore::TableExprNodeArray::TableExprNodeArray
TableExprNodeArray(NodeDataType, OperType)
Create the object.
casacore::TableExprNodeSet
Definition ExprNodeSet.h:87
casacore::TableExprUDFNodeArray::getArrayInt
MArray< Int64 > getArrayInt(const TableExprId &id) override
casacore::TableExprUDFNodeArray::getArrayString
MArray< String > getArrayString(const TableExprId &id) override
casacore::TableExprUDFNodeArray::disableApplySelection
void disableApplySelection() override
Do not apply the selection.
casacore::TableExprUDFNodeArray::itsUDF
std::shared_ptr< UDFBase > itsUDF
Definition ExprUDFNodeArray.h:112
casacore::TableExprUDFNodeArray::flattenTree
void flattenTree(std::vector< TableExprNodeRep * > &) override
Flatten the node tree by adding the node and its children to the vector.
casacore::TableExprUDFNodeArray::itsTableInfo
TableExprInfo itsTableInfo
Definition ExprUDFNodeArray.h:111
casacore::TableExprUDFNodeArray::applySelection
void applySelection(const Vector< rownr_t > &rownrs) override
If needed, let the UDF re-create column objects for a selection of rows.
casacore::TableExprUDFNodeArray::getArrayDComplex
MArray< DComplex > getArrayDComplex(const TableExprId &id) override
The default implementation of getArrayDComplex does getArrayDouble and converts the result.
casacore::TableExprUDFNodeArray::~TableExprUDFNodeArray
~TableExprUDFNodeArray() override=default
Destructor.
casacore::TableExprUDFNodeArray::TableExprUDFNodeArray
TableExprUDFNodeArray(const std::shared_ptr< UDFBase > &udf, const TableExprInfo &, const TableExprNodeSet &source)
Constructor.
casacore::TableExprUDFNodeArray::makeGroupAggrFunc
std::shared_ptr< TableExprGroupFuncBase > makeGroupAggrFunc() override
UDFs do not need a TableExprGroupFuncBase, so null is returned.
casacore::TableExprUDFNodeArray::getArrayDouble
MArray< Double > getArrayDouble(const TableExprId &id) override
The default implementation of getArrayDouble does getArrayInt and converts the result.
casacore::TableExprUDFNodeArray::getArrayDate
MArray< MVTime > getArrayDate(const TableExprId &id) override
casacore::TableExprUDFNodeArray::getArrayBool
MArray< Bool > getArrayBool(const TableExprId &id) override
Functions to get the desired result of a function.
casacore::TableExprUDFNodeArray::getTableInfo
TableExprInfo getTableInfo() const override
Get the table info.
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28