Clock.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 Clock.h
 * This header file contains the declaration of the described types in the IDL file.
 *
 * This file was generated by the tool gen.
 */
 
#ifndef _FAST_DDS_GENERATED_ROSGRAPH_MSG_CLOCK_H_
#define _FAST_DDS_GENERATED_ROSGRAPH_MSG_CLOCK_H_
// 条件编译预处理指令，用于防止头文件被重复包含。如果未定义_FAST_DDS_GENERATED_ROSGRAPH_MSG_CLOCK_H_这个宏，
// 则下面的代码内容会被编译，直到遇到#endif，若已定义该宏，则这段代码会被跳过，避免重复定义导致的编译错误。
#include "Time.h"
// 包含名为“Time.h”的头文件，可能是引入和时间相关的数据结构、函数等定义，用于当前类的实现或与之相关的操作。
#include <fastrtps/utils/fixed_size_string.hpp>
// 引入FastRTPS库中用于处理固定大小字符串的工具头文件，也许在当前类中会使用到相关功能来处理字符串数据。
#include <stdint.h>
#include <array>
#include <string>
#include <vector>
#include <map>
#include <bitset>
 
#if defined(_WIN32)
#if defined(EPROSIMA_USER_DLL_EXPORT)
#define eProsima_user_DllExport __declspec( dllexport )
#else
#define eProsima_user_DllExport
#endif  // EPROSIMA_USER_DLL_EXPORT
#else
#define eProsima_user_DllExport
#endif  // _WIN32
 
#if defined(_WIN32)
#if defined(EPROSIMA_USER_DLL_EXPORT)
#if defined(CLOCK_SOURCE)
#define CLOCK_DllAPI __declspec( dllexport )
#else
#define CLOCK_DllAPI __declspec( dllimport )
#endif // CLOCK_SOURCE
#else
#define CLOCK_DllAPI
#endif  // EPROSIMA_USER_DLL_EXPORT
#else
#define CLOCK_DllAPI
#endif // _WIN32
 
namespace eprosima {
namespace fastcdr {
class Cdr;
} // namespace fastcdr
} // namespace eprosima
 
namespace rosgraph {
    namespace msg {
        /*!
         * @brief This class represents the structure Clock defined by the user in the IDL file.
         * @ingroup Clock
         */
        class Clock
        {
        public:
 
            /*!
             * @brief Default constructor.
             */
            eProsima_user_DllExport Clock();
 
            /*!
             * @brief Default destructor.
             */
            eProsima_user_DllExport ~Clock();
 
            /*!
             * @brief Copy constructor.
             * @param x Reference to the object rosgraph::msg::Clock that will be copied.
             */
            eProsima_user_DllExport Clock(
                    const Clock& x);
 
            /*!
             * @brief Move constructor.
             * @param x Reference to the object rosgraph::msg::Clock that will be copied.
             */
            eProsima_user_DllExport Clock(
                    Clock&& x) noexcept;
 
            /*!
             * @brief Copy assignment.
             * @param x Reference to the object rosgraph::msg::Clock that will be copied.
             */
            eProsima_user_DllExport Clock& operator =(
                    const Clock& x);
 
            /*!
             * @brief Move assignment.
             * @param x Reference to the object rosgraph::msg::Clock that will be copied.
             */
            eProsima_user_DllExport Clock& operator =(
                    Clock&& x) noexcept;
 
            /*!
             * @brief Comparison operator.
             * @param x rosgraph::msg::Clock object to compare.
             */
            eProsima_user_DllExport bool operator ==(
                    const Clock& x) const;
 
            /*!
             * @brief Comparison operator.
             * @param x rosgraph::msg::Clock object to compare.
             */
            eProsima_user_DllExport bool operator !=(
                    const Clock& x) const;
 
            /*!
             * @brief This function copies the value in member clock
             * @param _clock New value to be copied in member clock
             */
            eProsima_user_DllExport void clock(
                    const builtin_interfaces::msg::Time& _clock);
 
            /*!
             * @brief This function moves the value in member clock
             * @param _clock New value to be moved in member clock
             */
            eProsima_user_DllExport void clock(
                    builtin_interfaces::msg::Time&& _clock);
 
            /*!
             * @brief This function returns a constant reference to member clock
             * @return Constant reference to member clock
             */
            eProsima_user_DllExport const builtin_interfaces::msg::Time& clock() const;
 
            /*!
             * @brief This function returns a reference to member clock
             * @return Reference to member clock
             */
            eProsima_user_DllExport builtin_interfaces::msg::Time& clock();
 
            /*!
            * @brief This function returns the maximum serialized size of an object
            * depending on the buffer alignment.
            * @param current_alignment Buffer alignment.
            * @return Maximum serialized size.
            */
            eProsima_user_DllExport static size_t getMaxCdrSerializedSize(
                    size_t current_alignment = 0);
 
            /*!
             * @brief This function returns the serialized size of a data depending on the buffer alignment.
             * @param data Data which is calculated its serialized size.
             * @param current_alignment Buffer alignment.
             * @return Serialized size.
             */
            eProsima_user_DllExport static size_t getCdrSerializedSize(
                    const rosgraph::msg::Clock& data,
                    size_t current_alignment = 0);
 
            /*!
             * @brief This function serializes an object using CDR serialization.
             * @param cdr CDR serialization object.
             */
            eProsima_user_DllExport void serialize(
                    eprosima::fastcdr::Cdr& cdr) const;
 
            /*!
             * @brief This function deserializes an object using CDR serialization.
             * @param cdr CDR serialization object.
             */
            eProsima_user_DllExport void deserialize(
                    eprosima::fastcdr::Cdr& cdr);
 
            /*!
             * @brief This function returns the maximum serialized size of the Key of an object
             * depending on the buffer alignment.
             * @param current_alignment Buffer alignment.
             * @return Maximum serialized size.
             */
            eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(
                    size_t current_alignment = 0);
 
            /*!
             * @brief This function tells you if the Key has been defined for this type
             */
            eProsima_user_DllExport static bool isKeyDefined();
 
            /*!
             * @brief This function serializes the key members of an object using CDR serialization.
             * @param cdr CDR serialization object.
             */
            eProsima_user_DllExport void serializeKey(
                    eprosima::fastcdr::Cdr& cdr) const;
 
        private:
            builtin_interfaces::msg::Time m_clock;
        };
    } // namespace msg
} // namespace rosgraph
 
#endif // _FAST_DDS_GENERATED_ROSGRAPH_MSG_CLOCK_H_