casacore::TableExprIdAggr Class Reference

The Table Expression Selection id used with aggregation. More...

#include <TableExprIdAggr.h>

Inheritance diagram for casacore::TableExprIdAggr:
casacore::TableExprId

List of all members.

Public Member Functions

 TableExprIdAggr (const CountedPtr< TableExprGroupResult > &result)
 Construct it from the aggregation results.
const TableExprGroupResultresult () const
 Get out the aggregation result object.
uInt getMagicValue () const
 Get the magic value (to check if it correct).

Static Public Member Functions

static const TableExprIdAggrcast (const TableExprId &id)
 Cast a TableExprId object to TableExprIdAggr.

Private Attributes

uInt itsMagicValue
CountedPtr< TableExprGroupResultitsResult

Detailed Description

The Table Expression Selection id used with aggregation.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tExprGroup

Synopsis

This class provides the user the ability to identify the data objects to test in a TaQL expression using aggregate functions.
It adds a TableExprGroupResult object to the TableExprId class which is used by the various classes derived from TableExprGroupFuncBase to get or evaluate the aggregated value. An aggregated value can be determined in two ways:

TableExprIdAggr contains a static function to (statically) cast a TableExprId object to TableExprIdAggr. A magic value is used to check that the cast is valid.
No dynamic_cast is used, because it requires TableExprId to contain virtual functions making the object larger. TaQL can hold quite large vectors of TableExprId objects, so such overhead is unacceptably large.

Motivation

This class makes it possible to retrieve aggregated values using the standard get functions taking an TableExprId.

Definition at line 87 of file TableExprIdAggr.h.


Constructor & Destructor Documentation

casacore::TableExprIdAggr::TableExprIdAggr ( const CountedPtr< TableExprGroupResult > &  result  )  [inline, explicit]

Construct it from the aggregation results.

Definition at line 91 of file TableExprIdAggr.h.


Member Function Documentation

static const TableExprIdAggr& casacore::TableExprIdAggr::cast ( const TableExprId id  )  [inline, static]

Cast a TableExprId object to TableExprIdAggr.

It check if the cast if correct by checking the magic value.

Definition at line 106 of file TableExprIdAggr.h.

References AlwaysAssert, and getMagicValue().

uInt casacore::TableExprIdAggr::getMagicValue (  )  const [inline]

Get the magic value (to check if it correct).

Definition at line 101 of file TableExprIdAggr.h.

References itsMagicValue.

Referenced by cast().

const TableExprGroupResult& casacore::TableExprIdAggr::result (  )  const [inline]

Get out the aggregation result object.

Definition at line 97 of file TableExprIdAggr.h.

References itsResult.


Member Data Documentation

Definition at line 114 of file TableExprIdAggr.h.

Referenced by getMagicValue().

Definition at line 115 of file TableExprIdAggr.h.

Referenced by result().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1