Fluent classes representing columns¶
Typically these are created by a
TableHandle::select
or
TableHandle::select
method. For example
auto [symbol, price] = table.getCols<StrCol, NumCol>("Symbol", "Price");
Leaf classes¶
-
class deephaven::client::highlevel::NumCol : public deephaven::client::highlevel::NumericExpression, public deephaven::client::highlevel::Column¶
Represents a numeric column in the fluent interface. Typically created by TableHandle::getNumCol() or TableHandle::getCols().
auto col2 = table.getNumCol("name2"); or auto [col1, col2, col3] = table.getCols<StrCol, NumCol, DateTimeCol>("name1", "name2", "name3")
Public Static Functions
-
static NumCol create(std::string name)¶
Create the NumCol. Used internally. Typically client code will call TableHandle::getNumCol() or TableHandle::getCols<>().
- Parameters
Column – name
- Returns
the NumCol
-
static NumCol create(std::string name)¶
-
class deephaven::client::highlevel::StrCol : public deephaven::client::highlevel::StringExpression, public deephaven::client::highlevel::Column¶
Represents a string column in the fluent interface. Typically created by
auto col1 = table.getStrCol("name1"); or auto [col1, col2, col3] = table.getCols<StrCol, NumCol, DateTimeCol>("name1", "name2", "name3")
Public Static Functions
-
static StrCol create(std::string name)¶
Create the StrCol. Used internally. Typically client code will call TableHandle::getStrCol() or TableHandle::getCols<>().
- Parameters
Column – name
- Returns
the StrCol
-
static StrCol create(std::string name)¶
-
class deephaven::client::highlevel::DateTimeCol : public deephaven::client::highlevel::DateTimeExpression, public deephaven::client::highlevel::Column¶
Represents a DateTime column in the fluent interface. Typically created by
auto col3 = table.getDateTimeCol("name3"); or auto [col1, col2, col3] = table.getCols<StrCol, NumCol, DateTimeCol>("name1", "name2", "name3")
Public Functions
Used internally.
-
DateTimeCol(DateTimeCol&&) = default¶
Move constructor.
-
DateTimeCol &operator=(DateTimeCol&&) = default¶
Move assignment operator.
-
~DateTimeCol() final¶
Destructor.
Public Static Functions
-
static DateTimeCol create(std::string name)¶
Create the DateTimeCol. Used internally. Typically client code will call TableHandle::getDateTimeCol() or TableHandle::getCols<>().
- Parameters
Column – name
- Returns
the DateTimeCol
Warning
doxygenclass: Cannot find class “deephaven::client::highlevel::BoolCol” in doxygen xml output for project “Deephaven C++ Client” from directory: ./doxygenoutput/xml
TODO(kosak) - BoolCol
Intermediate classes¶
These classes are typically not specified directly by client code. Instead they are used by library methods to indicate the type of column they work with.
-
class SelectColumn : public virtual deephaven::client::highlevel::IrisRepresentable¶
A base class for representing columns in the fluent interface. Objects inheriting from SelectColumn are suitable for use in methods like TableHandle::select() const Some common leaf classes are StrCol, NumCol, and DateTimeCol.
Subclassed by deephaven::client::highlevel::AssignedColumn, deephaven::client::highlevel::Column
-
class MatchWithColumn : public virtual deephaven::client::highlevel::IrisRepresentable¶
A base class used for representing columns that can be used for matching, in methods like TableHandle::exactJoin(const TableHandle &, std::vector<MatchWithColumn> columnsToMatch, std::vector<SelectColumn> columnsToAdd) const
Subclassed by deephaven::client::highlevel::Column
-
class deephaven::client::highlevel::AssignedColumn : public deephaven::client::highlevel::SelectColumn¶
Represents an expression that has been assigned to a new column name. Used for example in the TableHandle::select() method. Example:
auto newTable = tableHandle.select(A, B, (C + 5).as("NewCol"));
Public Functions
Constructor. Used internally.
-
AssignedColumn(AssignedColumn&&) = default¶
Move constructor.
-
AssignedColumn &operator=(AssignedColumn&&) = default¶
Move assignment operator.
-
~AssignedColumn() final¶
Destructor.
Public Static Functions
Create a new AssignedColumn. Used internally.
-
class deephaven::client::highlevel::Column : public deephaven::client::highlevel::SelectColumn, public deephaven::client::highlevel::MatchWithColumn¶
A base class for representing columns in the fluent interface.
Subclassed by deephaven::client::highlevel::DateTimeCol, deephaven::client::highlevel::NumCol, deephaven::client::highlevel::StrCol
Public Functions
Constructor. Used internally.