A Discrete-Event Network Simulator
API
length-example.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Lawrence Livermore National Laboratory
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Mathew Bielejeski <bielejeski1@llnl.gov>
18 */
19
20#include "ns3/core-module.h"
21#include "ns3/length.h"
22
23#include <iostream>
24
32using namespace ns3;
33
39void
41{
42 double input = 5;
43 Length::Quantity quantity(input, Length::Unit::Meter);
44
45 std::cout << "\nConstructors:"
46 << "\nLength (" << input << ", Unit::Meter) = " << Length(input, Length::Unit::Meter)
47 << "\nLength (" << input << ", \"m\") = " << Length(input, "m") << "\nLength ("
48 << input << ", \"meter\") = " << Length(input, "meter") << "\nLength (Quantity("
49 << input << ", Unit::Meter)) = " << Length(quantity)
50 << "\nLength (\"5m\") = " << Length("5m") << "\nLength (\"5 m\") = " << Length("5 m")
51 << "\nLength (\"5meter\") = " << Length("5meter")
52 << "\nLength (\"5 meter\") = " << Length("5 meter")
53 << "\nLength (\"5meters\") = " << Length("5meters")
54 << "\nLength (\"5 meters\") = " << Length("5 meters") << std::endl;
55}
56
62void
64{
65 // construct length using value and unit
66 Length moonDistance(3.84402e8, Length::Unit::Meter);
67
68 // Demonstrate conversion to various units
69 std::cout << "\n"
70 << "Conversions:\n"
71 << "Distance to moon = " << moonDistance << "\n"
72 << "In Feet: " << moonDistance.As(Length::Unit::Foot) << "\n"
73 << "In Miles: " << moonDistance.As(Length::Unit::Mile) << "\n"
74 << "In Kilometers: " << moonDistance.As(Length::Unit::Kilometer) << std::endl;
75}
76
82void
84{
85 double scale = 10;
86
87 // construct lengths using helper functions
88 Length oneMeter = Meters(1);
89 Length twoMeter = Meters(2);
90
91 std::cout << "\n"
92 << "Arithmetic Operations:\n"
93 << "Addition: " << oneMeter << " + " << twoMeter << " = " << (oneMeter + twoMeter)
94 << "\n"
95 << "Subtraction: " << twoMeter << " - " << oneMeter << " = " << (twoMeter - oneMeter)
96 << "\n"
97 << "Multiplication By Scalar: " << oneMeter << " * " << scale << " = "
98 << (oneMeter * scale) << "\n"
99 << "Division: " << oneMeter << " / " << twoMeter << " = " << (oneMeter / twoMeter)
100 << "\n"
101 << "Division By Scalar: " << oneMeter << " / " << scale << " = " << (oneMeter / scale)
102 << std::endl;
103}
104
110void
112{
113 Length oneMeter = Meters(1);
114 Length twoMeter = Meters(2);
115 Length threeMeter = Meters(3);
116
117 // NOLINTBEGIN(misc-redundant-expression)
118 std::cout << "\n"
119 << "Comparison Operations:\n"
120 << std::boolalpha << "Equality: " << oneMeter << " == " << oneMeter << " is "
121 << (oneMeter == oneMeter) << "\n"
122 << "Equality: " << oneMeter << " == " << twoMeter << " is " << (oneMeter == twoMeter)
123 << "\n"
124 << "Inequality: " << oneMeter << " != " << oneMeter << " is "
125 << (oneMeter != oneMeter) << "\n"
126 << "Inequality: " << oneMeter << " != " << twoMeter << " is "
127 << (oneMeter != twoMeter) << "\n"
128 << "Lesser: " << oneMeter << " < " << oneMeter << " is " << (oneMeter < oneMeter)
129 << "\n"
130 << "Lesser: " << oneMeter << " < " << twoMeter << " is " << (oneMeter < twoMeter)
131 << "\n"
132 << "Lesser: " << threeMeter << " < " << oneMeter << " is " << (threeMeter < oneMeter)
133 << "\n"
134 << "Greater: " << oneMeter << " > " << oneMeter << " is " << (oneMeter > oneMeter)
135 << "\n"
136 << "Greater: " << oneMeter << " > " << twoMeter << " is " << (oneMeter > twoMeter)
137 << "\n"
138 << "Greater: " << threeMeter << " > " << oneMeter << " is " << (threeMeter > oneMeter)
139 << std::endl;
140 // NOLINTEND(misc-redundant-expression)
141}
142
148void
150{
151 // construct length using helper function
152 Length totalLen = Feet(20);
153 Length pieceLen = Feet(3);
154 Length remainder;
155
156 int64_t count = Div(totalLen, pieceLen, &remainder);
157
158 std::cout << "\nHow many times can a " << totalLen.As(Length::Unit::Foot) << " length "
159 << "be split into " << pieceLen.As(Length::Unit::Foot) << " sized pieces? " << count
160 << "\nremainder: " << remainder.As(Length::Unit::Foot) << std::endl;
161
162 std::cout << "\nHow much remains after splitting a " << totalLen.As(Length::Unit::Foot)
163 << " length into " << pieceLen.As(Length::Unit::Foot) << " sized pieces? "
164 << Mod(totalLen, pieceLen).As(Length::Unit::Foot) << std::endl;
165}
166
167int
168main(int argc, char** argv)
169{
170 Constructors();
171 Conversions();
174 DivAndMod();
175
176 return 0;
177}
An immutable class which represents a value in a specific length unit.
Definition: length.h:272
Represents a length in meters.
Definition: length.h:244
Quantity As(Unit unit) const
Create a Quantity in a specific unit from a Length.
Definition: length.cc:386
Length Feet(double value)
Construct a length from a value in the indicated unit.
Definition: length.cc:829
Length Mod(const Length &numerator, const Length &denominator)
Calculate the amount remaining after dividing two lengths.
Definition: length.cc:500
void Conversions()
Demonstrates the use of ns3::Length conversions.
Length Meters(double value)
Construct a length from a value in the indicated unit.
Definition: length.cc:805
int64_t Div(const Length &numerator, const Length &denominator, Length *remainder)
Calculate how many times numerator can be split into denominator sized pieces.
Definition: length.cc:481
void Constructors()
Demonstrates the use of ns3::Length constructors.
void EqualityOperators()
Demonstrates the use of ns3::Length equality operators.
void ArithmeticOperators()
Demonstrates the use of ns3::Length arithmetic operators.
void DivAndMod()
Demonstrates the use of ns3::Length multiplications and divisions.
Every class exported by the ns3 library is enclosed in the ns3 namespace.