TF2Error.cpp

浏览该文件的文档.

// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
/*!
 * @file TF2Error.cpp
 * This source file contains the definition of the described types in the IDL file.
 *
 * This file was generated by the tool gen.
 */
 
#ifdef _WIN32
// Remove linker warning LNK4221 on Visual Studio
namespace {
char dummy;
}  // namespace
#endif  // _WIN32
 
#include "TF2Error.h"
#include <fastcdr/Cdr.h>
 
#include <fastcdr/exceptions/BadParamException.h>
using namespace eprosima::fastcdr::exception;
 
#include <utility>
 
#define tf2_msgs_msg_TF2Error_max_cdr_typesize 264ULL;
#define tf2_msgs_msg_TF2Error_max_key_cdr_typesize 0ULL;
 
tf2_msgs::msg::TF2Error::TF2Error()
{
    // 将 m_error 初始化为 0
    // m_error 是一个字节类型（octet），用于表示错误的代码或状态
    m_error = 0;
 
    // 将 m_error_string 初始化为空字符串
    // m_error_string 是一个字符串，用于描述错误的详细信息
    m_error_string = "";
}
 
 
tf2_msgs::msg::TF2Error::~TF2Error()
{
}
 
tf2_msgs::msg::TF2Error::TF2Error(
        const TF2Error& x)
{
    // 将输入对象 x 的 m_error 成员变量值赋给当前对象的 m_error
    m_error = x.m_error;
 
    // 将输入对象 x 的 m_error_string 成员变量值赋给当前对象的 m_error_string
    m_error_string = x.m_error_string;
}
 
 
tf2_msgs::msg::TF2Error::TF2Error(
        TF2Error&& x) noexcept
{
    // 将输入对象 x 的 m_error 成员变量值赋给当前对象的 m_error
    m_error = x.m_error;
 
    // 使用 std::move 将输入对象 x 的 m_error_string 移动到当前对象的 m_error_string
    // 这里使用 std::move 表示将 x.m_error_string 的资源转移到当前对象，避免不必要的拷贝
    m_error_string = std::move(x.m_error_string);
}
 
 
tf2_msgs::msg::TF2Error& tf2_msgs::msg::TF2Error::operator =(
        const TF2Error& x)
{
    m_error = x.m_error;
    m_error_string = x.m_error_string;
 
    return *this;
}
 
tf2_msgs::msg::TF2Error& tf2_msgs::msg::TF2Error::operator =(
        TF2Error&& x) noexcept
{
    m_error = x.m_error;
    m_error_string = std::move(x.m_error_string);
 
    return *this;
}
 
bool tf2_msgs::msg::TF2Error::operator ==(
        const TF2Error& x) const
{
    return (m_error == x.m_error && m_error_string == x.m_error_string);
}
 
bool tf2_msgs::msg::TF2Error::operator !=(
        const TF2Error& x) const
{
    return !(*this == x);
}
 
size_t tf2_msgs::msg::TF2Error::getMaxCdrSerializedSize(
        size_t current_alignment)
{
    static_cast<void>(current_alignment);
    return tf2_msgs_msg_TF2Error_max_cdr_typesize;
}
 
size_t tf2_msgs::msg::TF2Error::getCdrSerializedSize(
        const tf2_msgs::msg::TF2Error& data,
        size_t current_alignment)
{
    size_t initial_alignment = current_alignment;
    current_alignment += 1 + eprosima::fastcdr::Cdr::alignment(current_alignment, 1);
    current_alignment += 4 + eprosima::fastcdr::Cdr::alignment(current_alignment, 4) + data.error_string().size() + 1;
 
    return current_alignment - initial_alignment;
}
 
void tf2_msgs::msg::TF2Error::serialize(
        eprosima::fastcdr::Cdr& scdr) const
{
    // 将 m_error 成员变量序列化到 CDR 流中
    // scdr 是用于序列化的 Cdr 对象，"<<" 运算符表示将数据写入流中
    scdr << m_error;
 
    // 将 m_error_string 的 C 字符串（即 m_error_string.c_str()）序列化到 CDR 流中
    // 这里使用 c_str() 将 std::string 转换为 C 风格字符串（const char*），
    // 因为 FastCDR 库需要 C 风格的字符串来进行序列化
    scdr << m_error_string.c_str();
}
 
 
void tf2_msgs::msg::TF2Error::deserialize(  
        eprosima::fastcdr::Cdr& dcdr)  
{  
    // 从数据流中反序列化成员变量 m_error 和 m_error_string  
    dcdr >> m_error;            // 反序列化错误码  
    dcdr >> m_error_string;     // 反序列化错误信息字符串  
}  
 
/*!  
 * @brief 设置成员 error 的新值  
 * @param _error 新的错误码值  
 */  
void tf2_msgs::msg::TF2Error::error(  
        uint8_t _error)  
{  
    m_error = _error;           // 更新成员变量 m_error 的值  
}  
 
/*!  
 * @brief 返回成员 error 的值  
 * @return 成员 error 的值  
 */  
uint8_t tf2_msgs::msg::TF2Error::error() const  
{  
    return m_error;             // 返回当前错误码的值  
}  
 
/*!  
 * @brief 返回成员 error 的引用  
 * @return 成员 error 的引用  
 */  
uint8_t& tf2_msgs::msg::TF2Error::error()  
{  
    return m_error;             // 返回 m_error 的引用，以供修改  
}  
 
/*!  
 * @brief 复制新值到成员 error_string  
 * @param _error_string 新的错误信息字符串  
 */  
void tf2_msgs::msg::TF2Error::error_string(  
        const std::string& _error_string)  
{  
    m_error_string = _error_string; // 将新的错误字符串复制给成员变量 m_error_string  
}  
 
/*!  
 * @brief 移动新值到成员 error_string  
 * @param _error_string 新的错误信息字符串  
 */  
void tf2_msgs::msg::TF2Error::error_string(  
        std::string&& _error_string)  
{  
    m_error_string = std::move(_error_string); // 直接移动错误字符串到成员变量 m_error_string  
}  
 
/*!  
 * @brief 返回成员 error_string 的常量引用  
 * @return error_string 的常量引用  
 */  
const std::string& tf2_msgs::msg::TF2Error::error_string() const  
{  
    return m_error_string;     // 返回 m_error_string 的常量引用，不允许修改  
}  
 
/*!  
 * @brief 返回成员 error_string 的引用  
 * @return member error_string 的引用  
 */  
std::string& tf2_msgs::msg::TF2Error::error_string()  
{  
    return m_error_string;     // 返回 m_error_string 的引用，以供修改  
}  
 
 
size_t tf2_msgs::msg::TF2Error::getKeyMaxCdrSerializedSize(
        size_t current_alignment)
{
    // 静态转换 current_alignment 为 void，表示这个参数当前没有被使用
    // 该行代码的目的是消除未使用变量的编译警告
    static_cast<void>(current_alignment);
 
    // 返回最大键的 CDR 序列化大小
    // tf2_msgs_msg_TF2Error_max_key_cdr_typesize 是一个常量，表示 TF2Error 类型的键在 CDR 序列化格式中的最大大小
    return tf2_msgs_msg_TF2Error_max_key_cdr_typesize;
}
 
 
bool tf2_msgs::msg::TF2Error::isKeyDefined()
{
    return false;
}
 
void tf2_msgs::msg::TF2Error::serializeKey(
        eprosima::fastcdr::Cdr& scdr) const
{
    (void) scdr;
}