TypeDescriptor.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__TYPEDESCRIPTOR_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__TYPEDESCRIPTOR_HPP
 
#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 TypeDescriptor
{
public:
 
    using _ref_type = typename traits<TypeDescriptor>::ref_type;

    virtual TypeKind kind() const = 0;

    virtual TypeKind& kind() = 0;

    virtual void kind(
            TypeKind kind) = 0;

    virtual ObjectName& name() = 0;

    virtual const ObjectName& name() const = 0;

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

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

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

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

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

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

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

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

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

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

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

    virtual const BoundSeq& bound() const = 0;

    virtual BoundSeq& bound() = 0;

    virtual void bound(
            const BoundSeq& bound) = 0;

    virtual void bound(
            BoundSeq&& bound) = 0;

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

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

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

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

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

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

    virtual ExtensibilityKind extensibility_kind() const = 0;

    virtual ExtensibilityKind& extensibility_kind() = 0;

    virtual void extensibility_kind(
            ExtensibilityKind extensibility_kind) = 0;

    virtual bool is_nested() const = 0;

    virtual bool& is_nested() = 0;

    virtual void is_nested(
            bool is_nested) = 0;

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

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

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