From 4ef4d32cc3c864ff79298f55864f1831fd39ea3a Mon Sep 17 00:00:00 2001 From: Corey Kosak Date: Thu, 1 Jun 2023 17:59:03 -0400 Subject: [PATCH] Fix broken references in CPP client documentation (#3908) --- .../include/public/deephaven/client/client.h | 36 +++++++ cpp-client/deephaven/client/src/client.cc | 2 + cpp-client/doc/Doxyfile | 2 +- cpp-client/doc/chunks.rst | 84 ++++++++--------- cpp-client/doc/column_sources.rst | 84 ++++++++--------- cpp-client/doc/conf.py | 10 +- cpp-client/doc/main.rst | 3 + cpp-client/doc/row_sequences.rst | 30 +++--- cpp-client/doc/ticking.rst | 94 +++++++++---------- cpp-client/doc/types.rst | 2 +- 10 files changed, 195 insertions(+), 152 deletions(-) diff --git a/cpp-client/deephaven/client/include/public/deephaven/client/client.h b/cpp-client/deephaven/client/include/public/deephaven/client/client.h index 0ffd7bc13b1..34a9d00b0a5 100644 --- a/cpp-client/deephaven/client/include/public/deephaven/client/client.h +++ b/cpp-client/deephaven/client/include/public/deephaven/client/client.h @@ -150,14 +150,50 @@ class TableHandleManager { std::shared_ptr impl_; }; +/** + * The ClientOptions object is intended to be passed to Client::connect(). For convenience, the mutating methods can be + * chained. For example: + * auto client = Client::connect("localhost:10000", ClientOptions().setBasicAuthentication("foo", "bar").setSessionType("groovy") + */ class ClientOptions { public: + /* + * Default constructor. Creates a default ClientOptions object with default authentication and Python scripting. + */ ClientOptions(); + /** + * Move constructor + */ + ClientOptions(ClientOptions &&other) noexcept; + /** + * Move assigment operator. + */ + ClientOptions &operator=(ClientOptions &&other) noexcept; + /** + * Destructor + */ ~ClientOptions(); + /** + * Modifies the ClientOptions object to set the default authentication scheme. + * @return *this, so that methods can be chained. + */ ClientOptions &setDefaultAuthentication(); + /** + * Modifies the ClientOptions object to set the basic authentication scheme. + * @return *this, so that methods can be chained. + */ ClientOptions &setBasicAuthentication(const std::string &username, const std::string &password); + /** + * Modifies the ClientOptions object to set a custom authentication scheme. + * @return *this, so that methods can be chained. + */ ClientOptions &setCustomAuthentication(const std::string &authenticationKey, const std::string &authenticationValue); + /** + * Modifies the ClientOptions object to set the scripting language for the session. + * @param sessionType The scripting language for the session, such as "groovy" or "python". + * @return *this, so that methods can be chained. + */ ClientOptions &setSessionType(const std::string &sessionType); private: diff --git a/cpp-client/deephaven/client/src/client.cc b/cpp-client/deephaven/client/src/client.cc index 9ba31fb2afa..20f679ceb6c 100644 --- a/cpp-client/deephaven/client/src/client.cc +++ b/cpp-client/deephaven/client/src/client.cc @@ -52,6 +52,8 @@ ClientOptions::ClientOptions() { setSessionType("python"); } +ClientOptions::ClientOptions(ClientOptions &&other) noexcept = default; +ClientOptions &ClientOptions::operator=(ClientOptions &&other) noexcept = default; ClientOptions::~ClientOptions() = default; ClientOptions &ClientOptions::setDefaultAuthentication() { diff --git a/cpp-client/doc/Doxyfile b/cpp-client/doc/Doxyfile index a01fb98bf85..1eea92b8969 100644 --- a/cpp-client/doc/Doxyfile +++ b/cpp-client/doc/Doxyfile @@ -829,7 +829,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../deephaven/client +INPUT = ../deephaven/client ../deephaven/dhcore # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/cpp-client/doc/chunks.rst b/cpp-client/doc/chunks.rst index bbf3190f30b..715b5d9b420 100644 --- a/cpp-client/doc/chunks.rst +++ b/cpp-client/doc/chunks.rst @@ -4,94 +4,94 @@ Chunks Description ----------- -:cpp:class:`Chunk ` +:cpp:class:`Chunk ` is the abstract base class representing a simple typed data buffer. These buffers are used to pass data to and from the library, e.g. as arguments to -:cpp:func:`fillChunk ` +:cpp:func:`fillChunk ` or -:cpp:func:`fillFromChunk `. +:cpp:func:`fillFromChunk `. The concrete implementing classes are defined by the templated class -:cpp:class:`GenericChunk `. +:cpp:class:`GenericChunk `. For convenience we provide typedefs which instantiate -:cpp:class:`GenericChunk ` +:cpp:class:`GenericChunk ` on all the Deephaven types: -:cpp:type:`Int8Chunk `, -:cpp:type:`Int16Chunk `, -:cpp:type:`Int32Chunk `, -:cpp:type:`Int64Chunk `, -:cpp:type:`FloatChunk `, -:cpp:type:`DoubleChunk `, -:cpp:type:`BooleanChunk `, -:cpp:type:`StringChunk `, and -:cpp:type:`DateTimeChunk `. - -:cpp:class:`GenericChunk ` +:cpp:type:`Int8Chunk `, +:cpp:type:`Int16Chunk `, +:cpp:type:`Int32Chunk `, +:cpp:type:`Int64Chunk `, +:cpp:type:`FloatChunk `, +:cpp:type:`DoubleChunk `, +:cpp:type:`BooleanChunk `, +:cpp:type:`StringChunk `, and +:cpp:type:`DateTimeChunk `. + +:cpp:class:`GenericChunk ` also supports the methods -:cpp:func:`take ` and -:cpp:func:`drop ` to take slices of the -:cpp:class:`GenericChunk `. +:cpp:func:`take ` and +:cpp:func:`drop ` to take slices of the +:cpp:class:`GenericChunk `. AnyChunk -------- The -:cpp:class:`AnyChunk ` +:cpp:class:`AnyChunk ` class is a variant value type that can hold one of the concrete Chunk types described above. -:cpp:class:`AnyChunk ` is useful in certain limited cases +:cpp:class:`AnyChunk ` is useful in certain limited cases where a factory method needs to create a -:cpp:class:`Chunk ` +:cpp:class:`Chunk ` having a dynamically-determined type, not known at compile time. Of course this could also be accomplished by returning a heap-allocated pointer to a -:cpp:class:`Chunk `. +:cpp:class:`Chunk `. The rationale for using the variant approach rather than the heap-allocated object approach is for the sake of simplicity and efficiency when using these small objects. One example method that returns an -:cpp:class:`AnyChunk ` +:cpp:class:`AnyChunk ` is -:cpp:func:`createChunkFor `, +:cpp:func:`createChunkFor `, which creates a -:cpp:class:`Chunk ` +:cpp:class:`Chunk ` with a type appropriate to the passed-in -:cpp:class:`ColumnSource `, +:cpp:class:`ColumnSource `, and wraps that dynamicaly-determined Chunk in an -:cpp:class:`AnyChunk ` value. +:cpp:class:`AnyChunk ` value. Chunk Declarations ------------------ -.. doxygenclass:: deephaven::client::chunk::Chunk +.. doxygenclass:: deephaven::dhcore::chunk::Chunk :members: -.. doxygenclass:: deephaven::client::chunk::GenericChunk +.. doxygenclass:: deephaven::dhcore::chunk::GenericChunk :members: -.. doxygentypedef:: deephaven::client::chunk::Int8Chunk +.. doxygentypedef:: deephaven::dhcore::chunk::Int8Chunk -.. doxygentypedef:: deephaven::client::chunk::Int16Chunk +.. doxygentypedef:: deephaven::dhcore::chunk::Int16Chunk -.. doxygentypedef:: deephaven::client::chunk::Int32Chunk +.. doxygentypedef:: deephaven::dhcore::chunk::Int32Chunk -.. doxygentypedef:: deephaven::client::chunk::Int64Chunk +.. doxygentypedef:: deephaven::dhcore::chunk::Int64Chunk -.. doxygentypedef:: deephaven::client::chunk::FloatChunk +.. doxygentypedef:: deephaven::dhcore::chunk::FloatChunk -.. doxygentypedef:: deephaven::client::chunk::DoubleChunk +.. doxygentypedef:: deephaven::dhcore::chunk::DoubleChunk -.. doxygentypedef:: deephaven::client::chunk::BooleanChunk +.. doxygentypedef:: deephaven::dhcore::chunk::BooleanChunk -.. doxygentypedef:: deephaven::client::chunk::StringChunk +.. doxygentypedef:: deephaven::dhcore::chunk::StringChunk -.. doxygentypedef:: deephaven::client::chunk::DateTimeChunk +.. doxygentypedef:: deephaven::dhcore::chunk::DateTimeChunk Utility Declarations -------------------- -.. doxygenclass:: deephaven::client::chunk::AnyChunk +.. doxygenclass:: deephaven::dhcore::chunk::AnyChunk :members: -.. doxygenclass:: deephaven::client::chunk::ChunkVisitor +.. doxygenclass:: deephaven::dhcore::chunk::ChunkVisitor :members: -.. doxygenclass:: deephaven::client::chunk::ChunkMaker +.. doxygenclass:: deephaven::dhcore::chunk::ChunkMaker :members: diff --git a/cpp-client/doc/column_sources.rst b/cpp-client/doc/column_sources.rst index dde3e1c7964..f6af6c045dd 100644 --- a/cpp-client/doc/column_sources.rst +++ b/cpp-client/doc/column_sources.rst @@ -5,103 +5,103 @@ Description ----------- A -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` is an abstract class representing a Deephaven column. It represents a read-only view on that column. There is a derived class, -:cpp:class:`MutableColumnSource ` +:cpp:class:`MutableColumnSource ` which provides a writable interface. You can access the data in a -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` via its -:cpp:func:`fillChunk ` +:cpp:func:`fillChunk ` and -:cpp:func:`fillChunkUnordered ` +:cpp:func:`fillChunkUnordered ` methods. Likewise, you can store data into a -:cpp:class:`MutableColumnSource ` +:cpp:class:`MutableColumnSource ` via its -:cpp:func:`fillFromChunk ` +:cpp:func:`fillFromChunk ` and -:cpp:func:`fillFromChunkUnordered ` +:cpp:func:`fillFromChunkUnordered ` methods. These methods provide "bulk transfer" of data into and out of a -:cpp:class:`ColumnSource `. +:cpp:class:`ColumnSource `. We do not provide any methods to access single elements of a -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` because we want to encourage callers to use the more efficient bulk transfer methods. The -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` hierarchy is further divided into two parts: -:cpp:class:`NumericColumnSource ` +:cpp:class:`NumericColumnSource ` and -:cpp:class:`GenericColumnSource ` +:cpp:class:`GenericColumnSource ` (and their mutable counterparts -:cpp:class:`MutableNumericColumnSource ` +:cpp:class:`MutableNumericColumnSource ` and -:cpp:class:`MutableGenericColumnSource `). +:cpp:class:`MutableGenericColumnSource `). -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` is for representing columns containing the numeric Deephaven types (``int8_t``, ``int16_t``, ``int32_t``, ``int64_t``, ``float``, ``double``), whereas -:cpp:class:`ColumnSource ` +:cpp:class:`ColumnSource ` is for representing the remaining Deephaven types (``bool``, ``std::string``, and :cpp:class:`DateTime `). For these types we have a set of convenience typedefs: -* :cpp:type:`Int8ColumnSource ` -* :cpp:type:`Int16ColumnSource ` -* :cpp:type:`Int32ColumnSource ` -* :cpp:type:`Int64ColumnSource ` -* :cpp:type:`FloatColumnSource ` -* :cpp:type:`DoubleColumnSource ` -* :cpp:type:`BooleanColumnSource ` -* :cpp:type:`StringColumnSource ` -* :cpp:type:`DateTimeColumnSource ` +* :cpp:type:`Int8ColumnSource ` +* :cpp:type:`Int16ColumnSource ` +* :cpp:type:`Int32ColumnSource ` +* :cpp:type:`Int64ColumnSource ` +* :cpp:type:`FloatColumnSource ` +* :cpp:type:`DoubleColumnSource ` +* :cpp:type:`BooleanColumnSource ` +* :cpp:type:`StringColumnSource ` +* :cpp:type:`DateTimeColumnSource ` Declarations ------------ -.. doxygenclass:: deephaven::client::column::ColumnSource +.. doxygenclass:: deephaven::dhcore::column::ColumnSource :members: -.. doxygenclass:: deephaven::client::column::MutableColumnSource +.. doxygenclass:: deephaven::dhcore::column::MutableColumnSource :members: -.. doxygenclass:: deephaven::client::column::NumericColumnSource +.. doxygenclass:: deephaven::dhcore::column::NumericColumnSource :members: -.. doxygenclass:: deephaven::client::column::GenericColumnSource +.. doxygenclass:: deephaven::dhcore::column::GenericColumnSource :members: -.. doxygenclass:: deephaven::client::column::MutableNumericColumnSource +.. doxygenclass:: deephaven::dhcore::column::MutableNumericColumnSource :members: -.. doxygenclass:: deephaven::client::column::MutableGenericColumnSource +.. doxygenclass:: deephaven::dhcore::column::MutableGenericColumnSource :members: -.. doxygentypedef:: deephaven::client::column::Int8ColumnSource +.. doxygentypedef:: deephaven::dhcore::column::Int8ColumnSource -.. doxygentypedef:: deephaven::client::column::Int16ColumnSource +.. doxygentypedef:: deephaven::dhcore::column::Int16ColumnSource -.. doxygentypedef:: deephaven::client::column::Int32ColumnSource +.. doxygentypedef:: deephaven::dhcore::column::Int32ColumnSource -.. doxygentypedef:: deephaven::client::column::Int64ColumnSource +.. doxygentypedef:: deephaven::dhcore::column::Int64ColumnSource -.. doxygentypedef:: deephaven::client::column::FloatColumnSource +.. doxygentypedef:: deephaven::dhcore::column::FloatColumnSource -.. doxygentypedef:: deephaven::client::column::DoubleColumnSource +.. doxygentypedef:: deephaven::dhcore::column::DoubleColumnSource -.. doxygentypedef:: deephaven::client::column::BooleanColumnSource +.. doxygentypedef:: deephaven::dhcore::column::BooleanColumnSource -.. doxygentypedef:: deephaven::client::column::StringColumnSource +.. doxygentypedef:: deephaven::dhcore::column::StringColumnSource -.. doxygentypedef:: deephaven::client::column::DateTimeColumnSource +.. doxygentypedef:: deephaven::dhcore::column::DateTimeColumnSource Utility Declarations -------------------- -.. doxygenclass:: deephaven::client::column::ColumnSourceVisitor +.. doxygenclass:: deephaven::dhcore::column::ColumnSourceVisitor :members: diff --git a/cpp-client/doc/conf.py b/cpp-client/doc/conf.py index 0859bf8bc4d..88d8409ae76 100644 --- a/cpp-client/doc/conf.py +++ b/cpp-client/doc/conf.py @@ -59,9 +59,11 @@ # parent in the list. cpp_index_common_prefix = [ - 'deephaven::client::chunk::', 'deephaven::client::column::', - 'deephaven::client::container::', - 'deephaven::client::table::', 'deephaven::client::utility::', - 'deephaven::client::'] + 'deephaven::client::', + 'deephaven::dhcore::chunk::', + 'deephaven::dhcore::container::', + 'deephaven::dhcore::table::', + 'deephaven::dhcore::utility::', + 'deephaven::dhcore::'] diff --git a/cpp-client/doc/main.rst b/cpp-client/doc/main.rst index d4cfb6ecb72..6c1f4dc2e91 100644 --- a/cpp-client/doc/main.rst +++ b/cpp-client/doc/main.rst @@ -28,3 +28,6 @@ Declarations .. doxygenclass:: deephaven::client::Client :members: + +.. doxygenclass:: deephaven::client::ClientOptions + :members: diff --git a/cpp-client/doc/row_sequences.rst b/cpp-client/doc/row_sequences.rst index ad70ca999cc..981cee682a3 100644 --- a/cpp-client/doc/row_sequences.rst +++ b/cpp-client/doc/row_sequences.rst @@ -5,7 +5,7 @@ Description ----------- A -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` is an abstract class representing a monotonically-increasing sequence of row numbers that can be used to reference elements in a :cpp:class:`Table ` or @@ -16,39 +16,39 @@ It is used as a parameter to methods like :cpp:func:`fillChunk `. The row numbers inside a -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` are ``uint64_t`` values. The coordinate space used (whether key space or position space) is not specified, and is implied by context. However, as of this writing, all of the public methods in the C++ client that take -:cpp:class:`RowSequence ` arguments +:cpp:class:`RowSequence ` arguments assume they are in position space. -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` objects are immutable. They can be sliced via the -:cpp:func:`take ` +:cpp:func:`take ` and -:cpp:func:`drop ` +:cpp:func:`drop ` methods, which return new -:cpp:class:`RowSequence ` shared_ptrs. +:cpp:class:`RowSequence ` shared_ptrs. You can interrogate their size via -:cpp:func:`size ` or -:cpp:func:`empty `. +:cpp:func:`size ` or +:cpp:func:`empty `. You can iterate over them with -:cpp:func:`forEachInterval ` +:cpp:func:`forEachInterval ` or by obtaining a -:cpp:class:`RowSequenceIterator ` +:cpp:class:`RowSequenceIterator ` via -:cpp:func:`getRowSequenceIterator ` +:cpp:func:`getRowSequenceIterator ` Declarations ------------ -.. doxygenclass:: deephaven::client::container::RowSequence +.. doxygenclass:: deephaven::dhcore::container::RowSequence :members: -.. doxygenclass:: deephaven::client::container::RowSequenceBuilder +.. doxygenclass:: deephaven::dhcore::container::RowSequenceBuilder :members: -.. doxygenclass:: deephaven::client::container::RowSequenceIterator +.. doxygenclass:: deephaven::dhcore::container::RowSequenceIterator :members: diff --git a/cpp-client/doc/ticking.rst b/cpp-client/doc/ticking.rst index fcf149a1b8b..c9fb546f4b4 100644 --- a/cpp-client/doc/ticking.rst +++ b/cpp-client/doc/ticking.rst @@ -30,30 +30,30 @@ A simple example is: myTickingData.unsubscribe(std::move(subscriptionHandle)); The user-supplied ``MyCallback`` is a class deriving from -:cpp:class:`TickingCallback ` +:cpp:class:`TickingCallback ` which overrides two methods: -* :cpp:func:`onTick ` -* :cpp:func:`onFailure ` +* :cpp:func:`onTick ` +* :cpp:func:`onFailure ` When table data changes on the server side, those changes are batched up and periodically transmitted to the client (by default, at a rate of about once per second). First, the client library processes these low-level messages and applies them to its internal copy of the table. Then, it constructs a user-friendly -:cpp:class:`TickingUpdate ` +:cpp:class:`TickingUpdate ` object and invokes the user's -:cpp:func:`onTick ` +:cpp:func:`onTick ` callback, passing it the -:cpp:class:`TickingUpdate ` +:cpp:class:`TickingUpdate ` object. A skeleton of a user-defined callback object looks like this: .. code:: c++ - class MyCallback final : public deephaven::client::TickingCallback { + class MyCallback final : public deephaven::dhcore::ticking::TickingCallback { public: - void onTick(deephaven::client::TickingUpdate update) final { + void onTick(deephaven::dhcore::ticking::TickingUpdate update) final { // handle the update message } @@ -81,7 +81,7 @@ Notes: 1. shifts are a way to express the renumbering (but not reordering) of internal row keys. In this version of the client, we do not expose internal row keys to the caller. So you will not see shifts represented in the -:cpp:class:`TickingUpdate ` +:cpp:class:`TickingUpdate ` class in this version of the client. 2. In the above we explicitly refer to modified *cells* rather than modified *rows*, because @@ -89,19 +89,19 @@ when a row is modified, typically only some cells within that row change but oth For the sake of efficiency, the Barrage protocol allows the server to specify the specific cells that changed within a row. These modifications are represented on a per-column basis. That is, for each column, the library will indicate (via a -:cpp:class:`RowSequence `) +:cpp:class:`RowSequence `) which rows of that column were modified. The TickingUpdate class ----------------------- The -:cpp:class:`TickingUpdate ` +:cpp:class:`TickingUpdate ` class represents the changes that have happened to the table since the last tick. It contains snapshots -(:cpp:func:`prev ` +(:cpp:func:`prev ` and -:cpp:func:`current `) +:cpp:func:`current `) of the table at the start and end of the entire update operation, as well as intermediate snapshots @@ -110,13 +110,13 @@ as well as intermediate snapshots * before and after the modify operation. It also contains -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` values representing the positions of the removed, added, and modified items. For some callers, the per-update -:cpp:func:`prev ` +:cpp:func:`prev ` and -:cpp:func:`current ` +:cpp:func:`current ` table snapshots suffice for their needs. These snapshots tell the caller how the table looked before the update and after the update, respectively. Other callers will need more precise @@ -125,31 +125,31 @@ per-operation snapshots. The per-update snapshots are: -* :cpp:func:`prev ` - snapshot of the table before any of this cycle's updates were applied. -* :cpp:func:`current ` - snapshot of the table after all of this cycle's updates were applied. +* :cpp:func:`prev ` - snapshot of the table before any of this cycle's updates were applied. +* :cpp:func:`current ` - snapshot of the table after all of this cycle's updates were applied. The more fine-grained per-operation snaphots are: -* :cpp:func:`beforeRemoves ` - snapshot of the table as it appeared before the remove operation -* :cpp:func:`afterRemoves ` - snapshot of the table as it appeared after the remove operation -* :cpp:func:`beforeAdds ` - snapshot of the table as it appeared before the add operation -* :cpp:func:`afterAdds ` - snapshot of the table as it appeared after the add operation -* :cpp:func:`beforeModifies ` - snapshot of the table as it appeared before the modify operation -* :cpp:func:`afterModifies ` - snapshot of the table as it appeared after the modify operation +* :cpp:func:`beforeRemoves ` - snapshot of the table as it appeared before the remove operation +* :cpp:func:`afterRemoves ` - snapshot of the table as it appeared after the remove operation +* :cpp:func:`beforeAdds ` - snapshot of the table as it appeared before the add operation +* :cpp:func:`afterAdds ` - snapshot of the table as it appeared after the add operation +* :cpp:func:`beforeModifies ` - snapshot of the table as it appeared before the modify operation +* :cpp:func:`afterModifies ` - snapshot of the table as it appeared after the modify operation Some of these snapshots are duplicative: For example, due to the order in which changes are applied internally, it happens to be the case that -:cpp:func:`afterRemoves ` +:cpp:func:`afterRemoves ` and -:cpp:func:`beforeAdds ` +:cpp:func:`beforeAdds ` refer to exactly the same snapshot. We provide these extra snapshots for the programmer's convenience and intuition. The library also takes pains to coalesce snapshots. For example, if no removes happen in a given update, then the -:cpp:func:`beforeRemoves ` +:cpp:func:`beforeRemoves ` pointer will compare equal to the -:cpp:func:`afterRemoves ` +:cpp:func:`afterRemoves ` pointer. Some readers may be concerned about the cost of maintaining all these snapshots. Internally, @@ -161,44 +161,44 @@ implementation of this snapshotting data structure comes from the project. The -:cpp:class:`TickingUpdate ` +:cpp:class:`TickingUpdate ` object also provides -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` objects indicating which specific rows were changed. The provided -:cpp:class:`RowSequence ` +:cpp:class:`RowSequence ` objects are: -* :cpp:func:`removedRows ` - indexes of rows removed from the - :cpp:func:`beforeRemoves ` +* :cpp:func:`removedRows ` - indexes of rows removed from the + :cpp:func:`beforeRemoves ` snapshot to form - :cpp:func:`afterRemoves `. -* :cpp:func:`addedRows ` - indexes of rows added to the - :cpp:func:`beforeAdds ` + :cpp:func:`afterRemoves `. +* :cpp:func:`addedRows ` - indexes of rows added to the + :cpp:func:`beforeAdds ` snapshot to form - :cpp:func:`afterAdds `. -* :cpp:func:`modifiedRows ` - a ``std::vector`` of - :cpp:class:`RowSequence ` + :cpp:func:`afterAdds `. +* :cpp:func:`modifiedRows ` - a ``std::vector`` of + :cpp:class:`RowSequence ` shared_ptrs, which represents the modified data on a per-column basis. Each element of the vector is a - :cpp:class:`RowSequence ` + :cpp:class:`RowSequence ` shared_ptr representing the corresponding column. That - :cpp:class:`RowSequence ` + :cpp:class:`RowSequence ` provides the indexes of rows that were modified in the corresponding column of - :cpp:func:`beforeModifies ` + :cpp:func:`beforeModifies ` to form the corresponding column in - :cpp:func:`afterModifies `. + :cpp:func:`afterModifies `. Declarations ------------ -.. doxygenclass:: deephaven::client::table::Table +.. doxygenclass:: deephaven::dhcore::table::Table :members: -.. doxygenclass:: deephaven::client::table::Schema +.. doxygenclass:: deephaven::dhcore::table::Schema :members: -.. doxygenclass:: deephaven::client::TickingCallback +.. doxygenclass:: deephaven::dhcore::ticking::TickingCallback :members: -.. doxygenclass:: deephaven::client::TickingUpdate +.. doxygenclass:: deephaven::dhcore::ticking::TickingUpdate :members: diff --git a/cpp-client/doc/types.rst b/cpp-client/doc/types.rst index 21b17e25504..39b56afea40 100644 --- a/cpp-client/doc/types.rst +++ b/cpp-client/doc/types.rst @@ -14,5 +14,5 @@ Types used for sorting tables Types used for manipulating dates/times --------------------------------------- -.. doxygenclass:: deephaven::client::DateTime +.. doxygenclass:: deephaven::dhcore::DateTime :members: