apollo::cyber::record::RecordReader类 参考

The record reader. 更多...

#include <record_reader.h>

类 apollo::cyber::record::RecordReader 继承关系图:

apollo::cyber::record::RecordReader 的协作图:

Public 类型
using	FileReaderPtr = std::unique_ptr< RecordFileReader >
using	ChannelInfoMap = std::unordered_map< std::string, proto::ChannelCache >

Public 成员函数
	RecordReader (const std::string &file)
	The constructor with record file path as parameter.
virtual	~RecordReader ()
	The destructor.
bool	IsValid () const
	Is this record reader is valid.
bool	ReadMessage (RecordMessage *message, uint64_t begin_time=0, uint64_t end_time=std::numeric_limits< uint64_t >::max())
	Read one message from reader.
void	Reset ()
	Reset the message index of record reader.
uint64_t	GetMessageNumber (const std::string &channel_name) const override
	Get message number by channel name.
const std::string &	GetMessageType (const std::string &channel_name) const override
	Get message type by channel name.
const std::string &	GetProtoDesc (const std::string &channel_name) const override
	Get proto descriptor string by channel name.
std::set< std::string >	GetChannelList () const override
	Get channel list.
Public 成员函数 继承自 apollo::cyber::record::RecordBase
virtual	~RecordBase ()=default
	Destructor.
const proto::Header &	GetHeader () const
	Get record header.
const std::string	GetFile () const
	Get record file path.

额外继承的成员函数
Protected 属性 继承自 apollo::cyber::record::RecordBase
std::string	file_
proto::Header	header_
bool	is_opened_ = false

详细描述

The record reader.

在文件 record_reader.h 第 39 行定义.

成员类型定义说明

ChannelInfoMap

using apollo::cyber::record::RecordReader::ChannelInfoMap = std::unordered_map<std::string, proto::ChannelCache>

在文件 record_reader.h 第 42 行定义.

FileReaderPtr

using apollo::cyber::record::RecordReader::FileReaderPtr = std::unique_ptr<RecordFileReader>

在文件 record_reader.h 第 41 行定义.

构造及析构函数说明

RecordReader()

apollo::cyber::record::RecordReader::RecordReader ( const std::string &  file )

explicit

The constructor with record file path as parameter.

参数

file

在文件 record_reader.cc 第 32 行定义.

                                                {
  file_reader_.reset(new RecordFileReader());
  if (!file_reader_->Open(file)) {
    AERROR << "Failed to open record file: " << file;
    return;
  }
  chunk_.reset(new ChunkBody());
  is_valid_ = true;
  header_ = file_reader_->GetHeader();
  if (file_reader_->ReadIndex()) {
    index_ = file_reader_->GetIndex();
    for (int i = 0; i < index_.indexes_size(); ++i) {
      auto single_idx = index_.mutable_indexes(i);
      if (single_idx->type() != SectionType::SECTION_CHANNEL) {
        continue;
      }
      if (!single_idx->has_channel_cache()) {
        AERROR << "Single channel index does not have channel_cache.";
        continue;
      }
      auto channel_cache = single_idx->mutable_channel_cache();
      channel_info_.insert(
          std::make_pair(channel_cache->name(), *channel_cache));
    }
  }
  file_reader_->Reset();
}

~RecordReader()

apollo::cyber::record::RecordReader::~RecordReader ( )

virtual

The destructor.

在文件 record_reader.cc 第 30 行定义.

{}

成员函数说明

GetChannelList()

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

overridevirtual

Get channel list.

返回

List container with all channel name string.

实现了 apollo::cyber::record::RecordBase.

在文件 record_reader.cc 第 67 行定义.

                                                     {
  std::set<std::string> channel_list;
  for (auto& item : channel_info_) {
    channel_list.insert(item.first);
  }
  return channel_list;
}

GetMessageNumber()

uint64_t apollo::cyber::record::RecordReader::GetMessageNumber ( const std::string &  channel_name ) const

overridevirtual

Get message number by channel name.

参数

channel_name

返回

Message number.

实现了 apollo::cyber::record::RecordBase.

在文件 record_reader.cc 第 174 行定义.

                                                                           {
  auto search = channel_info_.find(channel_name);
  if (search == channel_info_.end()) {
    return 0;
  }
  return search->second.message_number();
}

GetMessageType()

const std::string & apollo::cyber::record::RecordReader::GetMessageType ( const std::string &  channel_name ) const

overridevirtual

Get message type by channel name.

参数

channel_name

返回

Message type.

实现了 apollo::cyber::record::RecordBase.

在文件 record_reader.cc 第 182 行定义.

                                         {
  auto search = channel_info_.find(channel_name);
  if (search == channel_info_.end()) {
    return kEmptyString;
  }
  return search->second.message_type();
}

GetProtoDesc()

const std::string & apollo::cyber::record::RecordReader::GetProtoDesc ( const std::string &  channel_name ) const

overridevirtual

Get proto descriptor string by channel name.

参数

channel_name

返回

Proto descriptor string by channel name.

实现了 apollo::cyber::record::RecordBase.

在文件 record_reader.cc 第 191 行定义.

                                         {
  auto search = channel_info_.find(channel_name);
  if (search == channel_info_.end()) {
    return kEmptyString;
  }
  return search->second.proto_desc();
}

IsValid()

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

inline

Is this record reader is valid.

返回

True for valid, false for not.

在文件 record_reader.h 第 61 行定义.

{ return is_valid_; }

ReadMessage()

bool apollo::cyber::record::RecordReader::ReadMessage	(	RecordMessage *	message,
		uint64_t	begin_time = 0,
		uint64_t	end_time = std::numeric_limits<uint64_t>::max()
	)

Read one message from reader.

参数

message
begin_time
end_time

返回

True for success, false for not.

在文件 record_reader.cc 第 75 行定义.

                                                  {
  if (!is_valid_) {
    return false;
  }
 
  if (begin_time > header_.end_time() || end_time < header_.begin_time()) {
    return false;
  }
 
  while (message_index_ < chunk_->messages_size()) {
    const auto& next_message = chunk_->messages(message_index_);
    uint64_t time = next_message.time();
    if (time > end_time) {
      return false;
    }
    ++message_index_;
    if (time < begin_time) {
      continue;
    }
 
    message->channel_name = next_message.channel_name();
    message->content = next_message.content();
    message->time = time;
    return true;
  }
 
  ADEBUG << "Read next chunk.";
  if (ReadNextChunk(begin_time, end_time)) {
    ADEBUG << "Read chunk successfully.";
    message_index_ = 0;
    return ReadMessage(message, begin_time, end_time);
  }
  ADEBUG << "No chunk to read.";
  return false;
}

Reset()

void apollo::cyber::record::RecordReader::Reset

(

)

Reset the message index of record reader.

在文件 record_reader.cc 第 60 行定义.

                         {
  file_reader_->Reset();
  reach_end_ = false;
  message_index_ = 0;
  chunk_.reset(new ChunkBody());
}

---

该类的文档由以下文件生成:

• cyber/record/record_reader.h
• cyber/record/record_reader.cc