Gazebo Common

API Reference

5.6.0
IO< DataFrame< K, math::InMemoryTimeVaryingVolumetricGrid< T, V, P > > > Struct Template Reference

Traits for IO of data frames comprised of time varying volumetric grids. More...

#include <DataFrame.hh>

Static Public Member Functions

static DataFrame< K, math::InMemoryTimeVaryingVolumetricGrid< T, V, P > > ReadFrom (CSVIStreamIterator _begin, CSVIStreamIterator _end, const size_t &_timeColumnIndex=0, const std::array< size_t, 3 > &_spatialColumnIndices={1, 2, 3})
 Read data frame from CSV data stream. More...
 
static DataFrame< K, math::InMemoryTimeVaryingVolumetricGrid< T, V, P > > ReadFrom (CSVIStreamIterator _begin, CSVIStreamIterator _end, const std::string &_timeColumnName, const std::array< std::string, 3 > &_spatialColumnNames)
 Read data frame from CSV data stream. More...
 

Detailed Description

template<typename K, typename T, typename V, typename P>
struct gz::common::IO< DataFrame< K, math::InMemoryTimeVaryingVolumetricGrid< T, V, P > > >

Traits for IO of data frames comprised of time varying volumetric grids.

Template Parameters
KData frame key type.
TTime coordinate type.
VGrid value type.
PSpatial dimensions type.

Member Function Documentation

◆ ReadFrom() [1/2]

static DataFrame<K, math::InMemoryTimeVaryingVolumetricGrid<T, V, P> > ReadFrom ( CSVIStreamIterator  _begin,
CSVIStreamIterator  _end,
const size_t &  _timeColumnIndex = 0,
const std::array< size_t, 3 > &  _spatialColumnIndices = {1, 2, 3} 
)
inlinestatic

Read data frame from CSV data stream.

Parameters
[in]_beginBeginning-of-stream iterator to CSV data stream.
[in]_endEnd-of-stream iterator to CSV data stream.
[in]_timeColumnIndexCSV data column index to use as time dimension.
[in]_spatialColumnIndicesCSV data columns indices to use as spatial (x, y, z) dimensions, in that order.
Exceptions
std::invalid_argumentif the CSV data stream is empty, or if the CSV data stream has no header, or if the given columns cannot be found in the CSV data stream header.
Returns
data frame read.

◆ ReadFrom() [2/2]

static DataFrame<K, math::InMemoryTimeVaryingVolumetricGrid<T, V, P> > ReadFrom ( CSVIStreamIterator  _begin,
CSVIStreamIterator  _end,
const std::string _timeColumnName,
const std::array< std::string, 3 > &  _spatialColumnNames 
)
inlinestatic

Read data frame from CSV data stream.

Parameters
[in]_beginBeginning-of-stream iterator to CSV data stream.
[in]_endEnd-of-stream iterator to CSV data stream.
[in]_timeColumnNameCSV data column name to use as time dimension.
[in]_spatialColumnNamesCSV data columns' names to use as spatial (x, y, z) dimensions, in that order.
Exceptions
std::invalid_argumentif the CSV data stream is empty, or if the CSV data stream has no header, or if the given columns cannot be found in the CSV data stream header.
Returns
data frame read.

References vector< T >::begin(), vector< T >::empty(), vector< T >::end(), std::find(), IO< T >::ReadFrom(), array< T >::size(), and stringstream::str().


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