apollo::cyber::WriterBase类 参考

Base class for a Writer. 更多...

#include <writer_base.h>

类 apollo::cyber::WriterBase 继承关系图:

apollo::cyber::WriterBase 的协作图:

Public 成员函数
	WriterBase (const proto::RoleAttributes &role_attr)
	Construct a new Writer Base object
virtual	~WriterBase ()
virtual bool	Init ()=0
	Init the Writer
virtual void	Shutdown ()=0
	Shutdown the Writer
virtual bool	HasReader ()
	Is there any Reader that subscribes our Channel? You can publish message when this return true
virtual void	GetReaders (std::vector< proto::RoleAttributes > *readers)
	Get all Readers that subscriber our writing channel
const std::string &	GetChannelName () const
	Get Writer's Channel name
const uint64_t	GetChannelId () const
	Get Writer's Channel id
bool	IsInit () const
	Is Writer initialized?

Protected 属性
proto::RoleAttributes	role_attr_
std::mutex	lock_
bool	init_

详细描述

Base class for a Writer.

A Writer is an object to send messages through a 'Channel'

警告

One Writer can only write one channel. But different writers can write through the same channel

在文件 writer_base.h 第 37 行定义.

构造及析构函数说明

WriterBase()

apollo::cyber::WriterBase::WriterBase ( const proto::RoleAttributes &  role_attr )

inlineexplicit

Construct a new Writer Base object

参数

role_attr

role attributes for this Writer

在文件 writer_base.h 第 44 行定义.

      : role_attr_(role_attr), init_(false) {}

~WriterBase()

virtual apollo::cyber::WriterBase::~WriterBase ( )

inlinevirtual

在文件 writer_base.h 第 46 行定义.

{}

成员函数说明

GetChannelId()

const uint64_t apollo::cyber::WriterBase::GetChannelId ( ) const

inline

Get Writer's Channel id

返回

const uint64_t& const reference to the channel id

在文件 writer_base.h 第 91 行定义.

{ return role_attr_.channel_id(); }

GetChannelName()

const std::string & apollo::cyber::WriterBase::GetChannelName ( ) const

inline

Get Writer's Channel name

返回

const std::string& const reference to the channel name

在文件 writer_base.h 第 82 行定义.

                                          {
    return role_attr_.channel_name();
  }

GetReaders()

virtual void apollo::cyber::WriterBase::GetReaders ( std::vector< proto::RoleAttributes > *  readers )

inlinevirtual

Get all Readers that subscriber our writing channel

参数

readers

result vector of RoleAttributes

被 apollo::cyber::Writer< MessageT > 重载.

在文件 writer_base.h 第 75 行定义.

{}

HasReader()

virtual bool apollo::cyber::WriterBase::HasReader ( )

inlinevirtual

Is there any Reader that subscribes our Channel? You can publish message when this return true

返回

true if the channel has reader

false if the channel has no reader

被 apollo::cyber::Writer< MessageT > 重载.

在文件 writer_base.h 第 68 行定义.

{ return false; }

Init()

virtual bool apollo::cyber::WriterBase::Init ( )

pure virtual

Init the Writer

返回

true if init success

false if init failed

在 apollo::cyber::blocker::IntraWriter< MessageT > , 以及 apollo::cyber::Writer< MessageT > 内被实现.

IsInit()

bool apollo::cyber::WriterBase::IsInit ( ) const

inline

Is Writer initialized?

返回

true if the Writer is inited

false if the Write is not inited

在文件 writer_base.h 第 99 行定义.

                      {
    std::lock_guard<std::mutex> g(lock_);
    return init_;
  }

Shutdown()

virtual void apollo::cyber::WriterBase::Shutdown ( )

pure virtual

Shutdown the Writer

在 apollo::cyber::blocker::IntraWriter< MessageT > , 以及 apollo::cyber::Writer< MessageT > 内被实现.

类成员变量说明

init_

bool apollo::cyber::WriterBase::init_

protected

在文件 writer_base.h 第 107 行定义.

lock_

std::mutex apollo::cyber::WriterBase::lock_

mutableprotected

在文件 writer_base.h 第 106 行定义.

role_attr_

proto::RoleAttributes apollo::cyber::WriterBase::role_attr_

protected

在文件 writer_base.h 第 105 行定义.

---

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

• cyber/node/writer_base.h