apollo::cyber::message::ArenaMessageWrapper类 参考

#include <arena_message_wrapper.h>

apollo::cyber::message::ArenaMessageWrapper 的协作图:

Public 成员函数
	ArenaMessageWrapper ()
	ArenaMessageWrapper (ArenaManagerBase *arena_manager)
virtual	~ArenaMessageWrapper ()
void	SetVersion (uint64_t version)
uint64_t	GetVersion () const
uint64_t	GetMessageAddress () const
void *	GetData ()
bool	FillMeta (void *meta, uint64_t size)
ArenaMessageWrapperMeta *	GetMeta ()
bool	FillExtended (void *extended, uint64_t size)
template<typename T >
T *	GetExtended ()
template<typename MessageT >
MessageT *	GetMessage ()
template<typename MessageT >
MessageT *	SetMessage (const MessageT &message)

静态 Public 属性
static const uint64_t	kDefaultVersion = 1L

详细描述

在文件 arena_message_wrapper.h 第 49 行定义.

构造及析构函数说明

ArenaMessageWrapper() [1/2]

apollo::cyber::message::ArenaMessageWrapper::ArenaMessageWrapper ( )

inline

在文件 arena_message_wrapper.h 第 53 行定义.

                        : arena_manager_(nullptr) {
    data_.struct_.meta_.struct_.version_ = kDefaultVersion;
    data_.struct_.meta_.struct_.addr_offset_ = 0;
  }

ArenaMessageWrapper() [2/2]

apollo::cyber::message::ArenaMessageWrapper::ArenaMessageWrapper ( ArenaManagerBase *  arena_manager )

inlineexplicit

在文件 arena_message_wrapper.h 第 58 行定义.

      : arena_manager_(arena_manager) {
    data_.struct_.meta_.struct_.version_ = kDefaultVersion;
    data_.struct_.meta_.struct_.addr_offset_ = 0;
  }

~ArenaMessageWrapper()

virtual apollo::cyber::message::ArenaMessageWrapper::~ArenaMessageWrapper ( )

inlinevirtual

在文件 arena_message_wrapper.h 第 64 行定义.

{}

成员函数说明

FillExtended()

bool apollo::cyber::message::ArenaMessageWrapper::FillExtended ( void *  extended, uint64_t  size  )

inline

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

                                                   {
    if (size > 256) {
      return false;
    }
    memcpy(&data_.struct_.extended_, extended, size);
    return true;
  }

FillMeta()

bool apollo::cyber::message::ArenaMessageWrapper::FillMeta ( void *  meta, uint64_t  size  )

inline

在文件 arena_message_wrapper.h 第 78 行定义.

                                           {
    if (size > 128) {
      return false;
    }
    memcpy(&data_.struct_.meta_, meta, size);
    return true;
  }

GetData()

void * apollo::cyber::message::ArenaMessageWrapper::GetData ( )

inline

在文件 arena_message_wrapper.h 第 76 行定义.

{ return reinterpret_cast<void*>(data_.bytes_); }

GetExtended()

template<typename T >

T * apollo::cyber::message::ArenaMessageWrapper::GetExtended ( )

inline

在文件 arena_message_wrapper.h 第 100 行定义.

                   {
    return reinterpret_cast<T*>(data_.struct_.extended_.bytes_);
  }

GetMessage()

template<typename MessageT >

MessageT * apollo::cyber::message::ArenaMessageWrapper::GetMessage ( )

inline

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

                         {
    // uint64_t base_address =
    //     reinterpret_cast<uint64_t>(arena_manager_->GetBaseAddress());
    // uint64_t message_address = base_address + data_.struct_.addr_offset_;
    // return std::shared_ptr<MessageT>(
    //     reinterpret_cast<MessageT*>(GetMessageAddress()));
    auto msg_ptr = arena_manager_->GetMessage<MessageT>(this);
    return msg_ptr;
  }

GetMessageAddress()

uint64_t apollo::cyber::message::ArenaMessageWrapper::GetMessageAddress ( ) const

inline

在文件 arena_message_wrapper.h 第 71 行定义.

                                     {
    return arena_manager_->GetBaseAddress(this) +
           data_.struct_.meta_.struct_.addr_offset_;
  }

GetMeta()

ArenaMessageWrapperMeta * apollo::cyber::message::ArenaMessageWrapper::GetMeta ( )

inline

在文件 arena_message_wrapper.h 第 86 行定义.

                                     {
    return reinterpret_cast<ArenaMessageWrapperMeta*>(
        data_.struct_.meta_.bytes_);
  }

GetVersion()

uint64_t apollo::cyber::message::ArenaMessageWrapper::GetVersion ( ) const

inline

在文件 arena_message_wrapper.h 第 69 行定义.

{ return data_.struct_.meta_.struct_.version_; }

SetMessage()

template<typename MessageT >

MessageT * apollo::cyber::message::ArenaMessageWrapper::SetMessage ( const MessageT &  message )

inline

在文件 arena_message_wrapper.h 第 116 行定义.

                                                {
    auto msg_ptr = arena_manager_->SetMessage(this, message);
    return msg_ptr;
  }

SetVersion()

void apollo::cyber::message::ArenaMessageWrapper::SetVersion ( uint64_t  version )

inline

在文件 arena_message_wrapper.h 第 66 行定义.

                                    {
    data_.struct_.meta_.struct_.version_ = version;
  }

类成员变量说明

kDefaultVersion

const uint64_t apollo::cyber::message::ArenaMessageWrapper::kDefaultVersion = 1L

static

在文件 arena_message_wrapper.h 第 51 行定义.

---

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

• cyber/message/arena_message_wrapper.h