PosePubSubTypes.h

浏览该文件的文档.

// 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 PosePubSubTypes.h
 * This header file contains the declaration of the serialization functions.
 *
 * This file was generated by the tool fastcdrgen.
 */
 
#ifndef _FAST_DDS_GENERATED_GEOMETRY_MSGS_MSG_POSE_PUBSUBTYPES_H_
#define _FAST_DDS_GENERATED_GEOMETRY_MSGS_MSG_POSE_PUBSUBTYPES_H_
 
#include <fastdds/dds/topic/TopicDataType.hpp>
#include <fastrtps/utils/md5.h>
 
#include "Pose.h"
 
#include "PointPubSubTypes.h"
#include "QuaternionPubSubTypes.h"
 
#if !defined(GEN_API_VER) || (GEN_API_VER != 1)
#error \
    Generated Pose is not compatible with current installed Fast DDS. Please, regenerate it with fastddsgen.
#endif  // GEN_API_VER
 
namespace geometry_msgs
{
    namespace msg
    {
        #ifndef SWIG
        namespace detail {
 
            template<typename Tag, typename Tag::type M>
            struct Pose_rob
            {
                friend constexpr typename Tag::type get(
                        Tag)
                {
                    return M;
                }
            };
 
            struct Pose_f
            {
                typedef geometry_msgs::msg::Quaternion Pose::* type;
                friend constexpr type get(
                        Pose_f);
            };
 
            template struct Pose_rob<Pose_f, &Pose::m_orientation>;
 
            template <typename T, typename Tag>
            inline size_t constexpr Pose_offset_of() {
                return ((::size_t) &reinterpret_cast<char const volatile&>((((T*)0)->*get(Tag()))));
            }
        }
        #endif
 
        /*!
         * @brief This class represents the TopicDataType of the type Pose defined by the user in the IDL file.
         * @ingroup POSE
         */
// 定义一个名为PosePubSubType的类，它继承自eprosima::fastdds::dds::TopicDataType类
        class PosePubSubType : public eprosima::fastdds::dds::TopicDataType
        {
        public:
 
// 定义一个类型别名，将类型名Pose作为该类内部使用的类型指代，方便后续代码中使用
            typedef Pose type;
 
// 构造函数，使用eProsima_user_DllExport修饰，通常用于在动态链接库中导出该函数，方便外部调用
            eProsima_user_DllExport PosePubSubType();
 
 // 析构函数，使用virtual关键字表示这是一个虚析构函数，且使用eProsima_user_DllExport修饰用于在动态链接库中导出，
    // override关键字表明它重写了基类中的虚析构函数，用于在对象销毁时进行正确的资源清理等操作
            eProsima_user_DllExport virtual ~PosePubSubType() override;
 
// 序列化函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，它接收要序列化的数据指针和一个用于存放序列化后负载的结构体指针，
    // override关键字表明重写了基类中的相应虚函数，用于将给定的数据按照特定规则进行序列化，以便在网络等场景中传输
            eProsima_user_DllExport virtual bool serialize(
                    void* data,
                    eprosima::fastrtps::rtps::SerializedPayload_t* payload) override;
 
// 反序列化函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，接收序列化后的负载结构体指针以及用于存放反序列化后数据的指针，
    // override关键字表明重写了基类中的相应虚函数，用于将接收到的序列化数据还原成原始的数据结构
            eProsima_user_DllExport virtual bool deserialize(
                    eprosima::fastrtps::rtps::SerializedPayload_t* payload,
                    void* data) override;
 
 // 获取序列化后数据大小的函数提供者函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，
    // 接收一个数据指针，返回一个无符号32位整数的函数对象，override关键字表明重写了基类中的相应虚函数，
    // 该函数主要用于获取给定数据序列化后的大小信息
            eProsima_user_DllExport virtual std::function<uint32_t()> getSerializedSizeProvider(
                    void* data) override;
 
// 获取键值的函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，接收数据指针、实例句柄指针以及一个布尔值（用于指定是否强制使用MD5等相关操作），
    // override关键字表明重写了基类中的相应虚函数，用于根据数据获取对应的键值，键值在一些数据关联、查找等操作中会起到重要作用
            eProsima_user_DllExport virtual bool getKey(
                    void* data,
                    eprosima::fastrtps::rtps::InstanceHandle_t* ihandle,
                    bool force_md5 = false) override;
 
// 创建数据的函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，override关键字表明重写了基类中的相应虚函数，
    // 该函数用于创建对应类型的数据对象，通常在需要初始化一个新的数据实例时调用
            eProsima_user_DllExport virtual void* createData() override;
 
// 删除数据的函数，使用eProsima_user_DllExport修饰用于在动态链接库中导出，接收一个数据指针，
    // override关键字表明重写了基类中的相应虚函数，用于释放由createData等方式创建的数据所占用的内存资源等
            eProsima_user_DllExport virtual void deleteData(
                    void* data) override;
 
        #ifdef TOPIC_DATA_TYPE_API_HAS_IS_BOUNDED
            eProsima_user_DllExport inline bool is_bounded() const override
            {
                return true;
            }
 
        #endif  // TOPIC_DATA_TYPE_API_HAS_IS_BOUNDED
 
        #ifdef TOPIC_DATA_TYPE_API_HAS_IS_PLAIN
            eProsima_user_DllExport inline bool is_plain() const override
            {
                return is_plain_impl();
            }
 
        #endif  // TOPIC_DATA_TYPE_API_HAS_IS_PLAIN
 
        #ifdef TOPIC_DATA_TYPE_API_HAS_CONSTRUCT_SAMPLE
            eProsima_user_DllExport inline bool construct_sample(
                    void* memory) const override
            {
                new (memory) Pose();
                return true;
            }
 
        #endif  // TOPIC_DATA_TYPE_API_HAS_CONSTRUCT_SAMPLE
            MD5 m_md5;
            unsigned char* m_keyBuffer;
        private:
            static constexpr bool is_plain_impl()
            {
                return 56ULL == (detail::Pose_offset_of<Pose, detail::Pose_f>() + sizeof(geometry_msgs::msg::Quaternion));
 
            }};
    }
}
 
#endif // _FAST_DDS_GENERATED_GEOMETRY_MSGS_MSG_POSE_PUBSUBTYPES_H_