src/core/boolean.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 09 Apr 2008 13:03:58 -0700
changeset 2928 554e10cdc747
parent 2584 5011c132ed6c
child 2965 4b28e9740e3b
permissions -rw-r--r--
add doxygen anchors to avoid warnings.
mathieu@2581
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
mathieu@2581
     2
/*
mathieu@2581
     3
 * Copyright (c) 2008 INRIA
mathieu@2581
     4
 *
mathieu@2581
     5
 * This program is free software; you can redistribute it and/or modify
mathieu@2581
     6
 * it under the terms of the GNU General Public License version 2 as
mathieu@2581
     7
 * published by the Free Software Foundation;
mathieu@2581
     8
 *
mathieu@2581
     9
 * This program is distributed in the hope that it will be useful,
mathieu@2581
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
mathieu@2581
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
mathieu@2581
    12
 * GNU General Public License for more details.
mathieu@2581
    13
 *
mathieu@2581
    14
 * You should have received a copy of the GNU General Public License
mathieu@2581
    15
 * along with this program; if not, write to the Free Software
mathieu@2581
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
mathieu@2581
    17
 *
mathieu@2581
    18
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
mathieu@2581
    19
 */
mathieu@2453
    20
#ifndef BOOLEAN_H
mathieu@2453
    21
#define BOOLEAN_H
mathieu@2371
    22
mathieu@2438
    23
#include "attribute.h"
mathieu@2451
    24
#include "attribute-helper.h"
mathieu@2371
    25
mathieu@2371
    26
namespace ns3 {
mathieu@2371
    27
mathieu@2584
    28
/**
mathieu@2584
    29
 * \brief Hold a bool native type
mathieu@2584
    30
 *
mathieu@2928
    31
 * \anchor bool
mathieu@2928
    32
 *
mathieu@2584
    33
 * This class can be used to hold bool variables
mathieu@2584
    34
 * which must go through the Attribute system.
mathieu@2584
    35
 */
mathieu@2441
    36
class Boolean
mathieu@2371
    37
{
mathieu@2371
    38
public:
mathieu@2441
    39
  Boolean ();
mathieu@2441
    40
  Boolean (bool value);
mathieu@2371
    41
  void Set (bool value);
mathieu@2371
    42
  bool Get (void) const;
mathieu@2371
    43
mathieu@2441
    44
  operator bool () const;
mathieu@2372
    45
mathieu@2441
    46
  ATTRIBUTE_CONVERTER_DEFINE (Boolean);
mathieu@2371
    47
private:
mathieu@2371
    48
  bool m_value;
mathieu@2371
    49
};
mathieu@2371
    50
mathieu@2441
    51
std::ostream & operator << (std::ostream &os, const Boolean &value);
mathieu@2441
    52
std::istream & operator >> (std::istream &is, Boolean &value);
mathieu@2410
    53
mathieu@2441
    54
ATTRIBUTE_VALUE_DEFINE (Boolean);
mathieu@2441
    55
ATTRIBUTE_CHECKER_DEFINE (Boolean);
mathieu@2441
    56
ATTRIBUTE_ACCESSOR_DEFINE (Boolean);
mathieu@2371
    57
mathieu@2371
    58
} // namespace ns3
mathieu@2371
    59
mathieu@2453
    60
#endif /* BOOLEAN_H */