Apollo  6.0
Open source self driving car software
Classes | Public Types | Public Member Functions | Friends | List of all members
apollo::cyber::record::RecordViewer Class Reference

The record viewer. More...

#include <record_viewer.h>

Collaboration diagram for apollo::cyber::record::RecordViewer:
Collaboration graph

Classes

class  Iterator
 The iterator. More...
 

Public Types

using RecordReaderPtr = std::shared_ptr< RecordReader >
 

Public Member Functions

 RecordViewer (const RecordReaderPtr &reader, uint64_t begin_time=0, uint64_t end_time=std::numeric_limits< uint64_t >::max(), const std::set< std::string > &channels={})
 The constructor with single reader. More...
 
 RecordViewer (const std::vector< RecordReaderPtr > &readers, uint64_t begin_time=0, uint64_t end_time=std::numeric_limits< uint64_t >::max(), const std::set< std::string > &channels=std::set< std::string >())
 The constructor with multiple readers. More...
 
bool IsValid () const
 Is this record reader is valid. More...
 
uint64_t begin_time () const
 Get begin time. More...
 
uint64_t end_time () const
 Get end time. More...
 
std::set< std::string > GetChannelList () const
 Get channel list. More...
 
Iterator begin ()
 Get the begin iterator. More...
 
Iterator end ()
 Get the end iterator. More...
 

Friends

class Iterator
 

Detailed Description

The record viewer.

Member Typedef Documentation

◆ RecordReaderPtr

Constructor & Destructor Documentation

◆ RecordViewer() [1/2]

apollo::cyber::record::RecordViewer::RecordViewer ( const RecordReaderPtr reader,
uint64_t  begin_time = 0,
uint64_t  end_time = std::numeric_limits< uint64_t >::max(),
const std::set< std::string > &  channels = {} 
)

The constructor with single reader.

Parameters
reader
begin_time
end_time
channels

◆ RecordViewer() [2/2]

apollo::cyber::record::RecordViewer::RecordViewer ( const std::vector< RecordReaderPtr > &  readers,
uint64_t  begin_time = 0,
uint64_t  end_time = std::numeric_limits< uint64_t >::max(),
const std::set< std::string > &  channels = std::set< std::string >() 
)

The constructor with multiple readers.

Parameters
readers
begin_time
end_time
channels

Member Function Documentation

◆ begin()

Iterator apollo::cyber::record::RecordViewer::begin ( )

Get the begin iterator.

Returns
The begin iterator.

◆ begin_time()

uint64_t apollo::cyber::record::RecordViewer::begin_time ( ) const
inline

Get begin time.

Returns
Begin time (nanoseconds).

◆ end()

Iterator apollo::cyber::record::RecordViewer::end ( )

Get the end iterator.

Returns
The end iterator.

◆ end_time()

uint64_t apollo::cyber::record::RecordViewer::end_time ( ) const
inline

Get end time.

Returns
end time (nanoseconds).

◆ GetChannelList()

std::set<std::string> apollo::cyber::record::RecordViewer::GetChannelList ( ) const
inline

Get channel list.

Returns
List container with all channel name string.

◆ IsValid()

bool apollo::cyber::record::RecordViewer::IsValid ( ) const

Is this record reader is valid.

Returns
True for valid, false for not.

Friends And Related Function Documentation

◆ Iterator

friend class Iterator
friend

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