#ifndef OMG_DDS_CORE_STATUS_STATE_HPP_
#define OMG_DDS_CORE_STATUS_STATE_HPP_

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * 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.
 */

#include <bitset>
#include <dds/core/macros.hpp>
#include <dds/core/types.hpp>


namespace dds
{
namespace core
{
namespace status
{

/**
 * @brief
 * Class to contain the statistics about samples that have been rejected.
 *
 * @see @ref DCPS_Modules_Subscription_SampleInfo "SampleInfo" for more information
 */
class OMG_DDS_API SampleRejectedState : public std::bitset<OMG_DDS_STATE_BIT_COUNT>
{
public:
    /**
     * Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.
     */
    typedef std::bitset<OMG_DDS_STATE_BIT_COUNT> MaskType;

public:
    /**
     * Construct an empty SampleRejectedState.
     */
    SampleRejectedState();

    /**
     * Copy constructor.
     *
     * Construct an SampleRejectedState with existing SampleRejectedState.
     *
     * @param src the SampleRejectedState to copy from
     */
    SampleRejectedState(const SampleRejectedState& src);

    /**
     * Construct a SampleRejectedState with existing MaskType.
     *
     * @param src the MaskType to copy from
     */
    SampleRejectedState(const MaskType& src);

public:
    /**
     * Get the NOT_REJECTED.
     *
     *<i>not_rejected</i>
     *      - No sample has been rejected yet.
     *
     * @return the not_rejected SampleRejectedState
     */
    inline static SampleRejectedState not_rejected()
    {
        return SampleRejectedState(0u);
    }

    /**
     * Get the REJECTED_BY_SAMPLES_LIMIT.
     *
     *<i>rejected_by_samples_limit</i>
     *      - The sample was rejected because it would
     *        exceed the maximum number of samples set by the ResourceLimits
     *        QosPolicy.
     *
     * @return the rejected_by_samples_limit SampleRejectedState
     */
    inline static SampleRejectedState rejected_by_samples_limit()
    {
        return SampleRejectedState(0x0001 << 1u);
    }

    /**
     * Get the REJECTED_BY_INSTANCES_LIMIT.
     *
     *<i>rejected_by_instances_limit</i>
     *      - The sample was rejected because it would
     *        exceed the maximum number of instances set by the
     *        ResourceLimits QosPolicy.
     *
     * @return the rejected_by_instances_limit SampleRejectedState
     */
    inline static SampleRejectedState rejected_by_instances_limit()
    {
        return SampleRejectedState(0x0001 << 0u);
    }

    /**
     * Get the REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT.
     *
     *<i>rejected_by_samples_per_instance_limit</i>
     *      - The sample was rejected
     *        because it would exceed the maximum number of samples per
     *        instance set by the ResourceLimits QosPolicy.
     *
     * @return the rejected_by_samples_per_instance_limit SampleRejectedState
     */
    inline static SampleRejectedState rejected_by_samples_per_instance_limit()
    {
        return SampleRejectedState(0x0001 << 2u);
    }

private:
    SampleRejectedState(uint32_t s);
};

/**
 * @brief
 * StatusMask is a bitmap or bitset field.
 *
 * This bitset is used to:
 * - determine which listener functions to call
 * - set conditions in dds::core::cond::StatusCondition
 * - indicate status changes when calling dds::core::Entity::status_changes
 *
 * @see @ref DCPS_Modules_Infrastructure_Status  "Status concept"
 */
class OMG_DDS_API StatusMask : public std::bitset<OMG_DDS_STATUS_COUNT>
{
public:
    /**
     * Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.
     */
    typedef std::bitset<OMG_DDS_STATUS_COUNT> MaskType;

public:
    /**
     * Construct an StatusMask with no flags set.
     */
    StatusMask();

    /**
     * Construct an StatusMask with an uint32_t bit mask.
     *
     * @param mask the bit array to initialize the bitset with
     */
    explicit StatusMask(uint32_t mask);

    /**
     * Copy constructor.
     *
     * Construct an StatusMask with existing StatusMask.
     *
     * @param other the StatusMask to copy from
     */
    StatusMask(const StatusMask& other);

    /** @cond */
    ~StatusMask();
    /** @endcond */

public:
    /**
     * Shift (merge) given StatusMask bits into this StatusMask bitset.
     *
     * @return StatusMask this
     */
    inline StatusMask& operator << (const dds::core::status::StatusMask& mask)
    {
        *this |= mask;
        return *this;
    }

    /**
     * Get all StatusMasks
     *
     * @return StatusMask all
     */
    inline static StatusMask all()
    {
        return StatusMask(0x80007fe7u);
    }

    /**
     * Get no StatusMasks
     *
     * @return StatusMask none
     */
    inline static StatusMask none()
    {
        return StatusMask(0u);
    }

public:
    /**
     * Get the StatusMask associated with dds::core::status::InconsistentTopicStatus
     *
     * @return StatusMask inconsistent_topic
     */
    inline static StatusMask inconsistent_topic()
    {
        return StatusMask(0x00000001 << 0u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::OfferedDeadlineMissedStatus
     *
     * @return StatusMask offered_deadline_missed
     */
    inline static StatusMask offered_deadline_missed()
    {
        return StatusMask(0x00000001 << 1u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::RequestedDeadlineMissedStatus
     *
     * @return StatusMask requested_deadline_missed
     */
    inline static StatusMask requested_deadline_missed()
    {
        return StatusMask(0x00000001 << 2u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::OfferedIncompatibleQosStatus
     *
     * @return StatusMask offered_incompatible_qos
     */
    inline static StatusMask offered_incompatible_qos()
    {
        return StatusMask(0x00000001 << 5u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::RequestedIncompatibleQosStatus
     *
     * @return StatusMask requested_incompatible_qos
     */
    inline static StatusMask requested_incompatible_qos()
    {
        return StatusMask(0x00000001 << 6u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::SampleLostStatus
     *
     * @return StatusMask sample_lost
     */
    inline static StatusMask sample_lost()
    {
        return StatusMask(0x00000001 << 7u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::SampleRejectedStatus
     *
     * @return StatusMask sample_rejected
     */
    inline static StatusMask sample_rejected()
    {
        return StatusMask(0x00000001 << 8u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::data_on_readers
     *
     * @return StatusMask data_on_readers
     */
    inline static StatusMask data_on_readers()
    {
        return StatusMask(0x00000001 << 9u);
    }

    /**
     * get the statusmask associated with dds::core::status::data_available
     *
     * @return statusmask data_available
     */
    inline static StatusMask data_available()
    {
        return StatusMask(0x00000001 << 10u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::LivelinessLostStatus
     *
     * @return StatusMask liveliness_lost
     */
    inline static StatusMask liveliness_lost()
    {
        return StatusMask(0x00000001 << 11u);
    }

    /**
     * Get the StatusMask associated with dds::core::status::LivelinessChangedStatus
     *
     * @return StatusMask liveliness_changed
     */
    inline static StatusMask liveliness_changed()
    {
        return StatusMask(0x00000001 << 12u);
    }

    /**
     * Get the statusmask associated with dds::core::status::PublicationMatchedStatus
     *
     * @return StatusMask publication_matched
     */
    inline static StatusMask publication_matched()
    {
        return StatusMask(0x00000001 << 13u);
    }

    /**
     * Get the statusmask associated with dds::core::status::SubscriptionMatchedStatus
     *
     * @return StatusMask subscription_matched
     */
    inline static StatusMask subscription_matched()
    {
        return StatusMask(0x00000001 << 14u);
    }

    /**
     * Get the statusmask associated with dds::core::status::AllDataDisposedTopicStatus
     *
     * @note This is a proprietary OpenSplice extension.
     *
     * @return StatusMask subscription_matched
     */
    inline static StatusMask all_data_disposed_topic()
    {
        return StatusMask(0x00000001u << 31u);
    }

};

}
}
} /* namespace dds / core / status*/


#endif /* OMG_DDS_CORE_STATUS_STATE_HPP_ */
