MemberDescriptor.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__MEMBERDESCRIPTOR_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__MEMBERDESCRIPTOR_HPP
 
#include <cstdint>
#include <string>
#include <vector>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
class DynamicType;
 
class FASTDDS_EXPORTED_API MemberDescriptor
{
public:
 
    using _ref_type = typename traits<MemberDescriptor>::ref_type;

    virtual ObjectName& name() = 0;

    virtual const ObjectName& name() const = 0;

    virtual void name(
            const ObjectName& name) = 0;

    virtual void name(
            ObjectName&& name) = 0;

    virtual MemberId id() const = 0;

    virtual MemberId& id() = 0;

    virtual void id(
            MemberId id) = 0;

    virtual MemberId position() const = 0;

    virtual MemberId& position() = 0;

    virtual void position(
            MemberId position) = 0;

    virtual traits<DynamicType>::ref_type type() const = 0;

    virtual traits<DynamicType>::ref_type& type() = 0;

    virtual void type(
            traits<DynamicType>::ref_type type) = 0;

    virtual std::string& default_value() = 0;

    virtual const std::string& default_value() const = 0;

    virtual void default_value(
            const std::string& default_value) = 0;

    virtual void default_value(
            std::string&& default_value) = 0;

    virtual std::string& literal_value() = 0;

    virtual const std::string& literal_value() const = 0;

    virtual void literal_value(
            const std::string& literal_value) = 0;

    virtual uint32_t& index() = 0;

    virtual uint32_t index() const = 0;

    virtual const UnionCaseLabelSeq& label() const = 0;

    virtual UnionCaseLabelSeq& label() = 0;

    virtual void label(
            const UnionCaseLabelSeq& label) = 0;

    virtual void label(
            UnionCaseLabelSeq&& label) = 0;

    virtual TryConstructKind try_construct_kind() const = 0;

    virtual TryConstructKind& try_construct_kind() = 0;

    virtual void try_construct_kind(
            TryConstructKind try_construct_kind) = 0;

    virtual bool is_key() const = 0;

    virtual bool& is_key() = 0;

    virtual void is_key(
            bool is_key) = 0;

    virtual bool is_optional() const = 0;

    virtual bool& is_optional() = 0;

    virtual void is_optional(
            bool is_optional) = 0;

    virtual bool is_must_understand() const = 0;

    virtual bool& is_must_understand() = 0;

    virtual void is_must_understand(
            bool is_must_understand) = 0;

    virtual bool is_shared() const = 0;

    virtual bool& is_shared() = 0;

    virtual void is_shared(
            bool is_shared) = 0;

    virtual bool is_default_label() const = 0;

    virtual bool& is_default_label() = 0;

    virtual void is_default_label(
            bool is_default_label) = 0;

    virtual bool is_default_literal() const = 0;

    virtual bool& is_default_literal() = 0;

    virtual void is_default_literal(
            bool is_default_literal) = 0;

    virtual ReturnCode_t copy_from(
            traits<MemberDescriptor>::ref_type descriptor) = 0;

    virtual bool equals(
            traits<MemberDescriptor>::ref_type descriptor) = 0;

    virtual bool is_consistent() = 0;
 
protected:
 
    MemberDescriptor() = default;
 
    MemberDescriptor(
            const MemberDescriptor& type) = default;
 
    MemberDescriptor(
            MemberDescriptor&& type) = default;
 
    virtual ~MemberDescriptor() = default;
 
private:
 
    MemberDescriptor& operator =(
            const MemberDescriptor& type) = delete;
 
    MemberDescriptor& operator =(
            MemberDescriptor&& type) = delete;
 
};
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__MEMBERDESCRIPTOR_HPP