Archetype: The query for the dataframe view. More...

#include <rerun/blueprint/archetypes/dataframe_query.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	DataframeQuery (DataframeQuery &&other)=default

	DataframeQuery (const DataframeQuery &other)=default

DataframeQuery &	operator= (const DataframeQuery &other)=default

DataframeQuery &	operator= (DataframeQuery &&other)=default

DataframeQuery	with_timeline (const rerun::blueprint::components::TimelineName &_timeline) &&
	The timeline for this query.

DataframeQuery	with_filter_by_range (const rerun::blueprint::components::FilterByRange &_filter_by_range) &&
	If provided, only rows whose timestamp is within this range will be shown.

DataframeQuery	with_filter_is_not_null (const rerun::blueprint::components::FilterIsNotNull &_filter_is_not_null) &&
	If provided, only show rows which contains a logged event for the specified component.

DataframeQuery	with_apply_latest_at (const rerun::blueprint::components::ApplyLatestAt &_apply_latest_at) &&
	Should empty cells be filled with latest-at queries?

DataframeQuery	with_select (const rerun::blueprint::components::SelectedColumns &_select) &&
	Selected columns. If unset, all columns are selected.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static DataframeQuery	update_fields ()
	Update only some specific fields of a `DataframeQuery`.

static DataframeQuery	clear_fields ()
	Clear all the fields of a `DataframeQuery`.

Public Attributes
std::optional< ComponentBatch >	timeline
	The timeline for this query.

std::optional< ComponentBatch >	filter_by_range
	If provided, only rows whose timestamp is within this range will be shown.

std::optional< ComponentBatch >	filter_is_not_null
	If provided, only show rows which contains a logged event for the specified component.

std::optional< ComponentBatch >	apply_latest_at
	Should empty cells be filled with latest-at queries?

std::optional< ComponentBatch >	select
	Selected columns. If unset, all columns are selected.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

static constexpr const char	ArchetypeName [] = "rerun.blueprint.archetypes.DataframeQuery"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_timeline
	`ComponentDescriptor` for the `timeline` field.

static constexpr auto	Descriptor_filter_by_range
	`ComponentDescriptor` for the `filter_by_range` field.

static constexpr auto	Descriptor_filter_is_not_null
	`ComponentDescriptor` for the `filter_is_not_null` field.

static constexpr auto	Descriptor_apply_latest_at
	`ComponentDescriptor` for the `apply_latest_at` field.

static constexpr auto	Descriptor_select
	`ComponentDescriptor` for the `select` field.

Detailed Description

Archetype: The query for the dataframe view.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

◆ with_timeline()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_timeline ( const rerun::blueprint::components::TimelineName & _timeline ) &&

inline

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

◆ with_filter_by_range()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_filter_by_range ( const rerun::blueprint::components::FilterByRange & _filter_by_range ) &&

inline

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::DataframeQuery::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::DataframeQuery::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ timeline

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::timeline

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

◆ filter_by_range

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::filter_by_range

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

◆ IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::DataframeQuery::IndicatorComponentName[]

staticconstexpr

Initial value:

=

"rerun.blueprint.components.DataframeQueryIndicator"

◆ Descriptor_timeline

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_timeline

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "timeline",
            Loggable<rerun::blueprint::components::TimelineName>::Descriptor.component_name
        )

ComponentDescriptor for the timeline field.

◆ Descriptor_filter_by_range

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_filter_by_range

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "filter_by_range",
            Loggable<rerun::blueprint::components::FilterByRange>::Descriptor.component_name
        )

ComponentDescriptor for the filter_by_range field.

◆ Descriptor_filter_is_not_null

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_filter_is_not_null

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "filter_is_not_null",
            Loggable<rerun::blueprint::components::FilterIsNotNull>::Descriptor.component_name
        )

ComponentDescriptor for the filter_is_not_null field.

◆ Descriptor_apply_latest_at

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_apply_latest_at

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "apply_latest_at",
            Loggable<rerun::blueprint::components::ApplyLatestAt>::Descriptor.component_name
        )

ComponentDescriptor for the apply_latest_at field.

◆ Descriptor_select

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_select

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "select",
            Loggable<rerun::blueprint::components::SelectedColumns>::Descriptor.component_name
        )

ComponentDescriptor for the select field.

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

rerun/blueprint/archetypes/dataframe_query.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_timeline()

◆ with_filter_by_range()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ timeline

◆ filter_by_range

◆ IndicatorComponentName

◆ Descriptor_timeline

◆ Descriptor_filter_by_range

◆ Descriptor_filter_is_not_null

◆ Descriptor_apply_latest_at

◆ Descriptor_select