This file is indexed.

/usr/include/ns3.27/ns3/dsss-parameter-set.h is in libns3-dev 3.27+dfsg-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 Sébastien Deronne
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef DSSS_PARAMETER_SET_H
#define DSSS_PARAMETER_SET_H

#include "wifi-information-element.h"

namespace ns3 {

/**
 * \brief The DSSS Parameter Set
 * \ingroup wifi
 *
 * This class knows how to serialise and deserialise the DSSS Parameter Set.
 */
class DsssParameterSet : public WifiInformationElement
{
public:
  DsssParameterSet ();
  /**
   * Set DSSS supported
   * \param DsssSupported the DSSS supported indicator
   */
  void SetDsssSupported (uint8_t DsssSupported);

  /**
   * Set the Current Channel field in the DsssParameterSet information element.
   *
   * \param currentChannel the CurrentChannel field in the DsssParameterSet information element
   */
  void SetCurrentChannel (uint8_t currentChannel);

  /**
   * Return the Current Channel field in the DsssParameterSet information element.
   *
   * \return the Current Channel field in the DsssParameterSet information element
   */
  uint8_t GetCurrentChannel (void) const;

  /**
   * Element ID function
   * \returns the wifi information element ID
   */
  WifiInformationElementId ElementId () const;
  /**
   * Get information field size function
   * \returns the information field size
   */
  uint8_t GetInformationFieldSize () const;
  /**
   * Serialize information field function
   * \param start the iterator
   * \returns the updated iterator
   */
  void SerializeInformationField (Buffer::Iterator start) const;
  /**
   * Deserialize infornamtion field function
   * \param start the iterator
   * \param length the length
   * \returns the updated iterator
   */
  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);

  /**
   * This information element is a bit special in that it is only
   * included if the STA does support DSSS. To support this we
   * override the Serialize and GetSerializedSize methods of
   * WifiInformationElement.
   *
   * \param start
   *
   * \return an iterator
   */
  Buffer::Iterator Serialize (Buffer::Iterator start) const;
  /**
   * Return the serialized size of this DSSS Parameter Set.
   *
   * \return the serialized size of this DSSS Parameter Set
   */
  uint16_t GetSerializedSize () const;


private:
  uint8_t m_currentChannel; ///< current channel number

  /// This is used to decide whether this element should be added to the frame or not
  bool m_dsssSupported;
};

std::ostream &operator << (std::ostream &os, const DsssParameterSet &dsssParameterSet);
std::istream &operator >> (std::istream &is, DsssParameterSet &dsssParameterSet);

ATTRIBUTE_HELPER_HEADER (DsssParameterSet);

} //namespace ns3

#endif /* DSSS_PARAMETER_SET_H */