modularization/thirdpartylib/FastRTPS/include/fastdds/rtps/attributes/PropertyPolicy.h

// Copyright 2016 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.

/*!
 * @file PropertyPolicy.h
 */
#ifndef _FASTDDS_RTPS_ATTRIBUTES_PROPERTYPOLICY_H_
#define _FASTDDS_RTPS_ATTRIBUTES_PROPERTYPOLICY_H_

#include <fastdds/rtps/common/Property.h>
#include <fastdds/rtps/common/BinaryProperty.h>
#include <fastrtps/fastrtps_dll.h>

namespace eprosima {
namespace fastrtps {
namespace rtps {

class PropertyPolicy
{
    public:
        RTPS_DllAPI PropertyPolicy() {}

        RTPS_DllAPI PropertyPolicy(const PropertyPolicy& property_policy) :
            properties_(property_policy.properties_),
            binary_properties_(property_policy.binary_properties_) {}

        RTPS_DllAPI PropertyPolicy(PropertyPolicy&& property_policy) :
            properties_(std::move(property_policy.properties_)),
            binary_properties_(std::move(property_policy.binary_properties_)) {}

        RTPS_DllAPI PropertyPolicy& operator=(const PropertyPolicy& property_policy)
        {
            properties_ = property_policy.properties_;
            binary_properties_ = property_policy.binary_properties_;
            return *this;
        }

        RTPS_DllAPI PropertyPolicy& operator=(PropertyPolicy&& property_policy)
        {
            properties_ = std::move(property_policy.properties_);
            binary_properties_= std::move(property_policy.binary_properties_);
            return *this;
        }

        RTPS_DllAPI bool operator==(const PropertyPolicy& b) const
        {
            return (this->properties_ == b.properties_) &&
                    (this->binary_properties_ == b.binary_properties_);
        }

        //!Get properties
        RTPS_DllAPI const PropertySeq& properties() const
        {
            return properties_;
        }

        //!Set properties
        RTPS_DllAPI PropertySeq& properties()
        {
            return properties_;
        }

        //!Get binary_properties
        RTPS_DllAPI const BinaryPropertySeq& binary_properties() const
        {
            return binary_properties_;
        }

        //!Set binary_properties
        RTPS_DllAPI BinaryPropertySeq& binary_properties()
        {
            return binary_properties_;
        }

    private:
        PropertySeq properties_;

        BinaryPropertySeq binary_properties_;
};

class PropertyPolicyHelper
{
    public:
        /*!
        * @brief Returns only the properties whose name starts with the prefix.
        * Prefix is removed in returned properties.
        * @param property_policy PropertyPolicy where properties will be searched.
        * @param prefix Prefix used to search properties.
        * @return A copy of properties whose name starts with the prefix.
        */
        RTPS_DllAPI static PropertyPolicy get_properties_with_prefix(
                const PropertyPolicy& property_policy,
                const std::string& prefix);

        //!Get the length of the property_policy
        RTPS_DllAPI static size_t length(const PropertyPolicy& property_policy);

        //!Look for a property_policy by name
        RTPS_DllAPI static std::string* find_property(
                PropertyPolicy& property_policy,
                const std::string& name);

        //!Retrieves a property_policy by name
        RTPS_DllAPI static const std::string* find_property(
                const PropertyPolicy& property_policy,
                const std::string& name);
};

} //namespace rtps
} //namespace fastrtps
} //namespace eprosima

#endif // _FASTDDS_RTPS_ATTRIBUTES_PROPERTYPOLICY_H_