text: /*
   * Copyright (c) 2016, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC)
   * 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.
   *
   * 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 XEROX OR PARC 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.
   */
  /* ################################################################################
   * #
   * # PATENT NOTICE
   * #
   * # This software is distributed under the BSD 2-clause License (see LICENSE
   * # file).  This BSD License does not make any patent claims and as such, does
   * # not act as a patent grant.  The purpose of this section is for each contributor
   * # to define their intentions with respect to intellectual property.
   * #
   * # Each contributor to this source code is encouraged to state their patent
   * # claims and licensing mechanisms for any contributions made. At the end of
   * # this section contributors may each make their own statements.  Contributor's
   * # claims and grants only apply to the pieces (source code, programs, text,
   * # media, etc) that they have contributed directly to this software.
   * #
   * # There is no guarantee that this section is complete, up to date or accurate. It
   * # is up to the contributors to maintain their portion of this section and up to
   * # the user of the software to verify any claims herein.
   * #
   * # Do not remove this header notification.  The contents of this section must be
   * # present in all distributions of the software.  You may only modify your own
   * # intellectual property statements.  Please provide contact information.
   *
   * - Palo Alto Research Center, Inc
   * This software distribution does not grant any rights to patents owned by Palo
   * Alto Research Center, Inc (PARC). Rights to these patents are available via
   * various mechanisms. As of January 2016 PARC has committed to FRAND licensing any
   * intellectual property used by its contributions to this software. You may
   * contact PARC at cipo@parc.com for more information or visit http://www.ccnx.org
   */
  
  #ifndef CCNS3_CCNXPERHOPHEADER_H
  #define CCNS3_CCNXPERHOPHEADER_H
  
  #include "ns3/ccnx-perhopheaderentry.h"
  
  namespace ns3  {
  namespace ccnx {
  
  /**
   * @ingroup ccnx-messages
   *
   * Class representation of the entire block of per hop header entries
   */
  class CCNxPerHopHeader : public SimpleRefCount<CCNxPerHopHeader>
  {
  public:
    /**
     * Base class constructor for CCNxPerHopHeader.
     *
     */
    CCNxPerHopHeader ();
  
    /**
     * Destructor for CCNxPerHopHeader
     */
    virtual ~CCNxPerHopHeader ();
  
    /**
     * Add CCNxPerHopHeaderEntry into the vector
     *
     * @param [in] header CCNxPerHopHeaderEntry to be added to the vector
     */
    void AddHeader(Ptr<CCNxPerHopHeaderEntry> header);
  
    /**
     * @return The size of the vector of per hop headers
     */
    size_t size(void) const;
  
    /**
     * Removes all elements of the vector
     */
    void clear(void);
  
    /**
     * Returns the CCNxPerHopHeaderEntry at the given index
     *
     * @param [in] index The index into the vector
     * @return CCNxPerHopHeaderEntry at the index location
     */
    Ptr<CCNxPerHopHeaderEntry> GetHeader(size_t index) const;
  
    /**
     * Drops the CCNxPerHopHeaderEntry at the given index
     *
     * @param [in] index The index into the vector
     */
    void DropHeader(size_t index);
  
    /**
     * Removes the CCNxPerHopHeaderEntry at the given index
     *
     * @param [in] The index from which CCNxPerHopHeaderEntry needs to be removed
     */
    void RemoveHeader(size_t index);
  
    /**
     * Determines if all perhopheaders are equivalent to the given perhopheaders.
     *
     * Two perhopheaders are equivalent if each per hop header entry is exactly equal
     * and in same order
     */
    bool Equals (const Ptr<CCNxPerHopHeader> other) const;
  
    /**
     * Determines if all perhopheaders are equivalent to the given perhopheaders.
     *
     * Two perhopheaders are equivalent if each per hop header entry is exactly equal
     * and in same order
     */
    bool Equals (CCNxPerHopHeader const &other) const;
  
    /**
     * Typedef defining a vector of CCNxPerHopHeaderEntry
     */
    typedef std::vector< Ptr<CCNxPerHopHeaderEntry> > HdrListType;
  
    friend std::ostream &operator<< (std::ostream &os, CCNxPerHopHeader const &headerlist);
  
  private:
  
    HdrListType m_perhopheaders;
  };
  
  }
  }
  
  #endif //CCNS3_CCNXPERHOPHEADER_H
  