Program Listing for File Annotation.hpp

↰ Return to documentation for file (/tmp/ws/src/fastrtps/include/dds/core/xtypes/Annotation.hpp)

/*
 * Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * Copyright 2019, 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 OMG_DDS_CORE_XTYPES_ANNOTATION_HPP_
#define OMG_DDS_CORE_XTYPES_ANNOTATION_HPP_
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

#include <dds/core/xtypes/detail/Annotation.hpp>
#include <dds/core/xtypes/TypeKind.hpp>
#include <dds/core/SafeEnumeration.hpp>
#include <dds/core/Reference.hpp>

namespace dds {
namespace core {
namespace xtypes {

template<typename DELEGATE>
class TIdAnnotation;

template<typename DELEGATE>
class TAnnotation : public Reference<DELEGATE>
{

    OMG_DDS_REF_TYPE_BASE(
        TAnnotation,
        dds::core::Reference,
        DELEGATE)

public:

    virtual ~TAnnotation();

    TypeKind kind() const;

    template<typename Q,
            template <typename> class K>
    operator K<Q>&()
    {
        return reinterpret_cast<K<Q>&>(*this);
    }

    const AnnotationKind& akind() const
    {
        return impl()->akind();
    }

protected:

    TAnnotation(
            const TypeKind& kind);
};

template<typename DELEGATE>
class TIdAnnotation : public TAnnotation<DELEGATE>
{
    using TAnnotation<DELEGATE>::impl;

public:

    TIdAnnotation(
            uint32_t id)
        : TAnnotation<DELEGATE>(TypeKind::ANNOTATION_TYPE)
    {
        impl()->id(id);
    }

    uint32_t id() const
    {
        return impl()->id();
    }

};

template<typename DELEGATE>
class TKeyAnnotation : public TAnnotation<DELEGATE>
{
    using TAnnotation<DELEGATE>::impl;

public:

    TKeyAnnotation()
    {
    }

};

template<typename DELEGATE>
class TSharedAnnotation : public TAnnotation<DELEGATE>
{
public:

    TSharedAnnotation()
    {
    }

};

template<typename DELEGATE>
class TNestedAnnotation : public TAnnotation<DELEGATE>
{
public:

    TNestedAnnotation()
    {
    }

};

template<typename DELEGATE>
class TExtensibilityAnnotation : public TAnnotation<DELEGATE>
{
    using TAnnotation<DELEGATE>::impl;

public:

    TExtensibilityAnnotation(
            ExtensibilityKind xkind)
    {
        impl()->xKind();
    }

    ExtensibilityKind extensibility_kind() const
    {
        return impl()->xKind();
    }

};

template<typename DELEGATE>
class TMustUnderstandAnnotation : public TAnnotation<DELEGATE>
{
public:

    TMustUnderstandAnnotation()
    {
    }

};

template<typename DELEGATE>
class TVerbatimAnnotation : public TAnnotation<DELEGATE>
{
    using TAnnotation<DELEGATE>::impl;

public:

    TVerbatimAnnotation(
            const std::string& text)
    {
        impl()->vbt(text);
    }

    const std::string& verbatim_text() const
    {
        return impl()->vbt();
    }

};

template<typename DELEGATE>
class TBitsetAnnotation : public TAnnotation<DELEGATE>
{
public:

    TBitsetAnnotation()
    {
    }

};

template<typename DELEGATE>
class TBitBoundAnnotation : public TAnnotation<DELEGATE>
{
    using TAnnotation<DELEGATE>::impl;

public:

    TBitBoundAnnotation(
            uint32_t bound)
    {
        impl()->bsb(bound);
    }

    virtual uint32_t bound() const
    {
        return impl()->bsb();
    }

    void bound(
            uint32_t bound)
    {
        impl()->bsb(bound);
    }

};

typedef TAnnotation<detail::Annotation> Annotation;

typedef TIdAnnotation<detail::IdAnnotation> IdAnnotation;

typedef TKeyAnnotation<detail::KeyAnnotation> KeyAnnotation;

typedef TSharedAnnotation<detail::SharedAnnotation> SharedAnnotation;

typedef TNestedAnnotation<detail::NestedAnnotation> NestedAnnotation;

typedef TExtensibilityAnnotation<detail::ExtensibilityAnnotation> ExtensibilityAnnotation;

typedef TMustUnderstandAnnotation<detail::MustUnderstandAnnotation> MustUnderstandAnnotation;

typedef TVerbatimAnnotation<detail::VerbatimAnnotation> VerbatimAnnotation;

typedef TBitsetAnnotation<detail::BitsetAnnotation> BitsetAnnotation;

typedef TBitBoundAnnotation<detail::BitBoundAnnotation> BitBoundAnnotation;

//FRANAVA We must think about the fact that previous API has a way of creating a
//dynamically defined Annotation.
/*
   namespace converter
   {
    IdAnnotation convert(const Annotation& a)
    {
        uint32_t idav = reinterpret_cast<const IdAnnotation&>(a).id();
        return IdAnnotation(idav);
    }
   }
 */
namespace annotation {

// These functions can be used to get cached instances,
// to avoid the proliferation of small annotation objects.
IdAnnotation id(
    uint32_t);

KeyAnnotation key();

SharedAnnotation shared();

NestedAnnotation nested();

ExtensibilityAnnotation extensibility(
        ExtensibilityKind kind);

ExtensibilityAnnotation get_final();

ExtensibilityAnnotation extensible();

ExtensibilityAnnotation get_mutable();

MustUnderstandAnnotation must_understand();

VerbatimAnnotation verbatim(
        const std::string& text);

BitsetAnnotation bitset();

BitsetAnnotation bit_bound(
        uint32_t bound);

} //namespace annotation
} //namespace xtypes
} //namespace core
} //namespace dds

#endif
#endif //OMG_DDS_CORE_XTYPES_TANNOTATION_HPP_