messagecomponent.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - Adjacent Link LLC, Bridgewater, New Jersey
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of Adjacent Link LLC nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMANEMODELTDMAMESSAGECOMPONENT_HEADER_
#define EMANEMODELTDMAMESSAGECOMPONENT_HEADER_

#include "emane/types.h"
#include "emane/utils/vectorio.h"

#include <list>
#include <vector>

namespace EMANE
{
  namespace Models
  {
    namespace TDMA
    {
      class MessageComponent
      {
      public:
        enum class Type
        {
          DATA, 
          CONTROL, 
         };

        using Data = std::vector<uint8_t>;

        MessageComponent(Type type,
                         NEMId destination,
                         Priority priority,
                         const Utils::VectorIO & vectorIO);

        MessageComponent(Type type,
                         NEMId destination,
                         Priority priority,
                         const Utils::VectorIO & vectorIO,
                         size_t fragmentIndex,
                         size_t fragmentOffset,
                         std::uint64_t u64FragmentSequence,
                         bool bMore);

        const Data & getData() const;

        NEMId getDestination() const;

        Type getType() const;

        bool isFragment() const;

        size_t getFragmentIndex() const;

        size_t getFragmentOffset() const;

        std::uint64_t getFragmentSequence() const;

        bool isMoreFragments() const;

        Priority getPriority() const;

      private:
        Type type_;
        NEMId destination_;
        Priority priority_;
        Data data_;
        size_t fragmentIndex_;
        size_t fragmentOffset_;
        bool bMoreFragments_;
        std::uint64_t u64FragmentSequence_;
      };

      using MessageComponents = std::list<MessageComponent>;
    }
  }

  #include "emane/models/tdma/messagecomponent.inl"
}

#endif // EMANEMODELTDMAMESSAGECOMPONENT_HEADER_