DynamicData.hpp

// Copyright 2023 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.
 
#ifndef FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICDATA_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICDATA_HPP
 
#include <memory>
#include <string>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/DynamicType.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/fastdds_dll.hpp>
#include <fastdds/rtps/common/Types.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
class DynamicData : public std::enable_shared_from_this<DynamicData>
{
public:
 
    using _ref_type = typename traits<DynamicData>::ref_type;
 
    FASTDDS_EXPORTED_API virtual traits<DynamicType>::ref_type type() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_descriptor(
            traits<MemberDescriptor>::ref_type& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual bool equals(
            traits<DynamicData>::ref_type other) = 0;
 
    FASTDDS_EXPORTED_API virtual MemberId get_member_id_by_name(
            const ObjectName& name) = 0;
 
    FASTDDS_EXPORTED_API virtual MemberId get_member_id_at_index(
            uint32_t index) = 0;
 
    FASTDDS_EXPORTED_API virtual uint32_t get_item_count() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t clear_all_values() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t clear_nonkey_values() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t clear_value(
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual traits<DynamicData>::ref_type loan_value(
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t return_loaned_value(
            traits<DynamicData>::ref_type value) = 0;
 
    FASTDDS_EXPORTED_API virtual traits<DynamicData>::ref_type clone() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int32_value(
            int32_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int32_value(
            MemberId id,
            int32_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint32_value(
            uint32_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint32_value(
            MemberId id,
            uint32_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int8_value(
            int8_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int8_value(
            MemberId id,
            int8_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint8_value(
            uint8_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint8_value(
            MemberId id,
            uint8_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int16_value(
            int16_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int16_value(
            MemberId id,
            int16_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint16_value(
            uint16_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint16_value(
            MemberId id,
            uint16_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int64_value(
            int64_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int64_value(
            MemberId id,
            int64_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint64_value(
            uint64_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint64_value(
            MemberId id,
            uint64_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float32_value(
            float& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float32_value(
            MemberId id,
            float value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float64_value(
            double& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float64_value(
            MemberId id,
            double value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float128_value(
            long double& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float128_value(
            MemberId id,
            long double value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_char8_value(
            char& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_char8_value(
            MemberId id,
            char value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_char16_value(
            wchar_t& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_char16_value(
            MemberId id,
            wchar_t value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_byte_value(
            eprosima::fastdds::rtps::octet& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_byte_value(
            MemberId id,
            eprosima::fastdds::rtps::octet value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_boolean_value(
            bool& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_boolean_value(
            MemberId id,
            bool value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_string_value(
            std::string& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_string_value(
            MemberId id,
            const std::string& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_wstring_value(
            std::wstring& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_wstring_value(
            MemberId id,
            const std::wstring& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_complex_value(
            traits<DynamicData>::ref_type& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_complex_value(
            MemberId id,
            traits<DynamicData>::ref_type value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int32_values(
            Int32Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int32_values(
            MemberId id,
            const Int32Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint32_values(
            UInt32Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint32_values(
            MemberId id,
            const UInt32Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int8_values(
            Int8Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int8_values(
            MemberId id,
            const Int8Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint8_values(
            UInt8Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint8_values(
            MemberId id,
            const UInt8Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int16_values(
            Int16Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int16_values(
            MemberId id,
            const Int16Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint16_values(
            UInt16Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint16_values(
            MemberId id,
            const UInt16Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_int64_values(
            Int64Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_int64_values(
            MemberId id,
            const Int64Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_uint64_values(
            UInt64Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_uint64_values(
            MemberId id,
            const UInt64Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float32_values(
            Float32Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float32_values(
            MemberId id,
            const Float32Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float64_values(
            Float64Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float64_values(
            MemberId id,
            const Float64Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_float128_values(
            Float128Seq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_float128_values(
            MemberId id,
            const Float128Seq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_char8_values(
            CharSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_char8_values(
            MemberId id,
            const CharSeq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_char16_values(
            WcharSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_char16_values(
            MemberId id,
            const WcharSeq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_byte_values(
            ByteSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_byte_values(
            MemberId id,
            const ByteSeq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_boolean_values(
            BooleanSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_boolean_values(
            MemberId id,
            const BooleanSeq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_string_values(
            StringSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_string_values(
            MemberId id,
            const StringSeq& value) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_wstring_values(
            WstringSeq& value,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t set_wstring_values(
            MemberId id,
            const WstringSeq& value) = 0;
 
protected:
 
    DynamicData() = default;
 
    virtual ~DynamicData() = default;
 
    traits<DynamicData>::ref_type _this();
 
private:
 
    DynamicData(
            const DynamicData&) = delete;
 
    DynamicData(
            DynamicData&&) = delete;
 
    DynamicData& operator =(
            const DynamicData&) = delete;
 
    DynamicData& operator =(
            DynamicData&&) = delete;
};
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICDATA_HPP