Arrow-encoded data for a column of time points. More...

#include <rerun/time_column.hpp>

Public Member Functions
	TimeColumn (Timeline timeline, Collection< int64_t > times, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a time column from an array of time points.

Error	to_c_ffi_struct (rr_time_column &out_column) const
	To rerun C API component batch.

Static Public Member Functions
static TimeColumn	from_sequence_points (std::string timeline_name, Collection< int64_t > sequence_points, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a time column from an array of sequence points.

static TimeColumn	from_sequence (std::string timeline_name, Collection< int64_t > sequence_points, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a column from an array of sequence points, e.g.

static TimeColumn	from_nanoseconds (std::string timeline_name, Collection< int64_t > times_in_nanoseconds, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a time column from an array of nanoseconds.

static TimeColumn	from_seconds (std::string timeline_name, Collection< double > times_in_secs, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a time column from an array of seconds.

template<typename TRep , typename TPeriod >
static TimeColumn	from_durations (std::string timeline_name, const Collection< std::chrono::duration< TRep, TPeriod > > &durations, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a time column from an array of arbitrary std::chrono durations.

template<typename TRep , typename TPeriod >
static TimeColumn	from_times (std::string timeline_name, const Collection< std::chrono::duration< TRep, TPeriod > > &chrono_times, SortingStatus sorting_status=SortingStatus::Unknown)

static TimeColumn	from_duration_nanoseconds (std::string timeline_name, Collection< int64_t > duration_in_nanos, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a duration column from an array of nanoseconds.

static TimeColumn	from_duration_secs (std::string timeline_name, Collection< double > duration_in_secs, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a duration column from an array of seconds.

template<typename TClock >
static TimeColumn	from_time_points (std::string timeline_name, const Collection< std::chrono::time_point< TClock > > &time_points, SortingStatus sorting_status=SortingStatus::Unknown)

static TimeColumn	from_nanos_since_epoch (std::string timeline_name, Collection< int64_t > timestamp_in_nanos, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a timestamp column from an array of nanoseconds since Unix Epoch (1970-01-01 00:00:00 UTC).

static TimeColumn	from_secs_since_epoch (std::string timeline_name, Collection< double > timestamp_in_secs, SortingStatus sorting_status=SortingStatus::Unknown)
	Creates a duration column from an array of seconds since Unix Epoch (1970-01-01 00:00:00 UTC).

Public Attributes
Timeline	timeline
	The timeline this column belongs to.

std::shared_ptr< arrow::Array >	array
	Time points as a primitive array of i64.

SortingStatus	sorting_status
	The sorting order of the `times` array.

Detailed Description

Arrow-encoded data for a column of time points.

See also: rerun::RecordingStream::send_columns

Constructor & Destructor Documentation

◆ TimeColumn()

rerun::TimeColumn::TimeColumn	(	Timeline	timeline,
		Collection< int64_t >	times,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

Creates a time column from an array of time points.

Parameters

timeline	The timeline this column belongs to.
times	The time values. Depending on the `TimeType` of the timeline this may be either sequence numbers, durations, or timestamps. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

Member Function Documentation

◆ from_sequence_points()

static TimeColumn rerun::TimeColumn::from_sequence_points	(	std::string	timeline_name,
		Collection< int64_t >	sequence_points,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a time column from an array of sequence points.

Parameters

timeline_name	The name of the timeline this column belongs to.
sequence_points	The sequence points. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the sequence points. Already sorted time points may perform better.

Deprecated:: Use from_sequence instead.

◆ from_sequence()

static TimeColumn rerun::TimeColumn::from_sequence	(	std::string	timeline_name,
		Collection< int64_t >	sequence_points,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a column from an array of sequence points, e.g.

frame numbers.

Parameters

timeline_name	The name of the timeline this column belongs to.
sequence_points	The sequence points. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the sequence points. Already sorted time points may perform better.

◆ from_nanoseconds()

static TimeColumn rerun::TimeColumn::from_nanoseconds	(	std::string	timeline_name,
		Collection< int64_t >	times_in_nanoseconds,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a time column from an array of nanoseconds.

Parameters

timeline_name	The name of the timeline this column belongs to.
times_in_nanoseconds	Time values in nanoseconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_seconds()

static TimeColumn rerun::TimeColumn::from_seconds	(	std::string	timeline_name,
		Collection< double >	times_in_secs,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

static

Creates a time column from an array of seconds.

Parameters

timeline_name	The name of the timeline this column belongs to.
times_in_secs	Time values in seconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_durations()

template<typename TRep , typename TPeriod >

static TimeColumn rerun::TimeColumn::from_durations	(	std::string	timeline_name,
		const Collection< std::chrono::duration< TRep, TPeriod > > &	durations,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a time column from an array of arbitrary std::chrono durations.

Parameters

timeline_name	The name of the timeline this column belongs to.
durations	Time values as chrono durations. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_times()

template<typename TRep , typename TPeriod >

static TimeColumn rerun::TimeColumn::from_times	(	std::string	timeline_name,
		const Collection< std::chrono::duration< TRep, TPeriod > > &	chrono_times,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Deprecated:: Use from_durations instead.

◆ from_duration_nanoseconds()

static TimeColumn rerun::TimeColumn::from_duration_nanoseconds	(	std::string	timeline_name,
		Collection< int64_t >	duration_in_nanos,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a duration column from an array of nanoseconds.

Parameters

timeline_name	The name of the timeline this column belongs to.
duration_in_nanos	Duration values in nanoseconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_duration_secs()

static TimeColumn rerun::TimeColumn::from_duration_secs	(	std::string	timeline_name,
		Collection< double >	duration_in_secs,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a duration column from an array of seconds.

Parameters

timeline_name	The name of the timeline this column belongs to.
duration_in_secs	Duration values in seconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_nanos_since_epoch()

static TimeColumn rerun::TimeColumn::from_nanos_since_epoch	(	std::string	timeline_name,
		Collection< int64_t >	timestamp_in_nanos,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a timestamp column from an array of nanoseconds since Unix Epoch (1970-01-01 00:00:00 UTC).

Parameters

timeline_name	The name of the timeline this column belongs to.
timestamp_in_nanos	Timestamp values in nanoseconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ from_secs_since_epoch()

static TimeColumn rerun::TimeColumn::from_secs_since_epoch	(	std::string	timeline_name,
		Collection< double >	timestamp_in_secs,
		SortingStatus	sorting_status = `SortingStatus::Unknown`
	)

inlinestatic

Creates a duration column from an array of seconds since Unix Epoch (1970-01-01 00:00:00 UTC).

Parameters

timeline_name	The name of the timeline this column belongs to.
timestamp_in_secs	Timestamp values in seconds. Make sure the sorting status is correctly specified.
sorting_status	The sorting status of the time points. Already sorted time points may perform better.

◆ to_c_ffi_struct()

Error rerun::TimeColumn::to_c_ffi_struct ( rr_time_column & out_column ) const

To rerun C API component batch.

The resulting rr_time_column keeps the arrow::Array alive until it is released.

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

rerun/time_column.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeColumn()

Member Function Documentation

◆ from_sequence_points()

◆ from_sequence()

◆ from_nanoseconds()

◆ from_seconds()

◆ from_durations()

◆ from_times()

◆ from_duration_nanoseconds()

◆ from_duration_secs()

◆ from_nanos_since_epoch()

◆ from_secs_since_epoch()

◆ to_c_ffi_struct()