Program Listing for File AnnotationDescriptor.h

↰ Return to documentation for file (/tmp/ws/src/fastrtps/include/fastrtps/types/AnnotationDescriptor.h)

// Copyright 2018 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 TYPES_ANNOTATION_DESCRIPTOR_H
#define TYPES_ANNOTATION_DESCRIPTOR_H

#include <fastrtps/types/TypesBase.h>
#include <fastrtps/types/DynamicTypePtr.h>

namespace eprosima{
namespace fastrtps{
namespace types{

class MemberDescriptor;
class DynamicType;

class AnnotationDescriptor
{
protected:
    friend class DynamicTypeBuilderFactory;

    DynamicType_ptr type_;
    std::map<std::string, std::string> value_;

public:
    AnnotationDescriptor();
    ~AnnotationDescriptor();
    AnnotationDescriptor(const AnnotationDescriptor* descriptor);
    AnnotationDescriptor(DynamicType_ptr p_type);

    ReturnCode_t copy_from(const AnnotationDescriptor* other);
    bool equals(const AnnotationDescriptor*) const;
    bool is_consistent() const;
    bool key_annotation() const;

    ReturnCode_t get_value(
            std::string& value,
            const std::string& key);

    ReturnCode_t get_value(std::string& value); // key = "value"

    ReturnCode_t get_all_value(std::map<std::string, std::string>& value) const;

    ReturnCode_t set_value(
        const std::string& key,
        const std::string& value);

    void set_type(DynamicType_ptr pType);

    const DynamicType_ptr type() const
    {
        return type_;
    }
};

} // namespace types
} // namespace fastrtps
} // namespace eprosima

#endif // TYPES_ANNOTATION_DESCRIPTOR_H