ITypeObjectRegistry.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_TYPE_REPRESENTATION__ITYPEOBJECTREGISTRY_HPP
#define FASTDDS_DDS_XTYPES_TYPE_REPRESENTATION__ITYPEOBJECTREGISTRY_HPP
 
#include <string>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/DynamicType.hpp>
#include <fastdds/dds/xtypes/type_representation/TypeObject.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
namespace xtypes {
 
struct TypeObjectPair
{
    // Minimal TypeObject
    TypeObject minimal_type_object;
    // Complete TypeObject
    TypeObject complete_type_object;
};
 
class ITypeObjectRegistry
{
public:
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t register_type_object(
            const std::string& type_name,
            const CompleteTypeObject& complete_type_object,
            TypeIdentifierPair& type_ids) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t register_type_object(
            const TypeObject& type_object,
            TypeIdentifierPair& type_ids) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t register_typeobject_w_dynamic_type(
            const DynamicType::_ref_type& dynamic_type,
            TypeIdentifierPair& type_ids) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t register_type_identifier(
            const std::string& type_name,
            TypeIdentifierPair& type_identifier) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t get_type_objects(
            const std::string& type_name,
            TypeObjectPair& type_objects) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t get_type_identifiers(
            const std::string& type_name,
            TypeIdentifierPair& type_identifiers) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t get_type_object(
            const TypeIdentifier& type_identifier,
            TypeObject& type_object) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t get_complete_type_object(
            const TypeIdentifierPair& type_identifiers,
            CompleteTypeObject& type_object) = 0;
 
    virtual FASTDDS_EXPORTED_API ReturnCode_t get_type_information(
            const TypeIdentifierPair& type_ids,
            TypeInformation& type_information,
            bool with_dependencies = false) = 0;
};
 
 
} // xtypes
} // dds
} // fastdds
} // eprosima
 
#endif // FASTDDS_DDS_XTYPES_TYPE_REPRESENTATION__ITYPEOBJECTREGISTRY_HPP