length.h File Reference

Declaration of ns3::Length class. More...

#include "attribute-helper.h"
#include "attribute.h"
#include <istream>
#include <limits>
#include <optional>
#include <ostream>
#include <string>

Include dependency graph for length.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ns3::Length
	Represents a length in meters. More...
class	ns3::LengthChecker
	AttributeChecker implementation for LengthValue. More...
class	ns3::LengthValue
	AttributeValue implementation for Length. More...
class	ns3::Length::Quantity
	An immutable class which represents a value in a specific length unit. More...

Namespaces
namespace	ns3
	Every class exported by the ns3 library is enclosed in the ns3 namespace.

Functions
int64_t	ns3::Div (const Length &numerator, const Length &denominator, Length *remainder=nullptr)
	Calculate how many times numerator can be split into denominator sized pieces.
std::optional< Length::Unit >	ns3::FromString (std::string unitString)
	Find the equivalent Length::Unit for a unit string.
template<typename T1>
Ptr< const AttributeAccessor >	ns3::MakeLengthAccessor (T1 a1)
	Create an AttributeAccessor for a class data member, or a lone class get functor or set method.
template<typename T1, typename T2>
Ptr< const AttributeAccessor >	ns3::MakeLengthAccessor (T1 a1, T2 a2)
	Create an AttributeAccessor using a pair of get functor and set methods from a class.
Ptr< const AttributeChecker >	ns3::MakeLengthChecker ()
Length	ns3::Mod (const Length &numerator, const Length &denominator)
	Calculate the amount remaining after dividing two lengths.
bool	ns3::operator!= (const Length &left, const Length &right)
	Compare two length objects for inequality.
Length	ns3::operator* (const Length &l, double scalar)
	Multiply a length value by a scalar.
Length	ns3::operator* (double scalar, const Length &l)
	Multiply a length value by a scalar.
Length	ns3::operator+ (const Length &left, const Length &right)
	Add two length values together.
Length	ns3::operator- (const Length &left, const Length &right)
	Subtract two length values.
Length	ns3::operator/ (const Length &left, double scalar)
	Divide a length value by a scalar.
double	ns3::operator/ (const Length &numerator, const Length &denominator)
	Divide a length value by another length value.
bool	ns3::operator< (const Length &left, const Length &right)
	Check if left has a value less than right.
std::ostream &	ns3::operator<< (std::ostream &stream, const Length &l)
	Write a length value to an output stream.
std::ostream &	ns3::operator<< (std::ostream &stream, const Length::Quantity &q)
	Write a Quantity to an output stream.
std::ostream &	ns3::operator<< (std::ostream &stream, Length::Unit unit)
	Write a Length::Unit to an output stream.
bool	ns3::operator<= (const Length &left, const Length &right)
	Check if left has a value less than or equal to right.
bool	ns3::operator== (const Length &left, const Length &right)
	Compare two length objects for equality.
bool	ns3::operator> (const Length &left, const Length &right)
	Check if left has a value greater than right.
bool	ns3::operator>= (const Length &left, const Length &right)
	Check if left has a value greater than or equal to right.
std::istream &	ns3::operator>> (std::istream &stream, Length &l)
	Read a length value from an input stream.
std::string	ns3::ToName (Length::Unit unit, bool plural=false)
	Return the name of the supplied unit.
std::string	ns3::ToSymbol (Length::Unit unit)
	Return the symbol of the supplied unit.
Length	ns3::CentiMeters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::Feet (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::Inches (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::KiloMeters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::Meters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::MicroMeters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::Miles (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::MilliMeters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::NanoMeters (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::NauticalMiles (double value)
	Construct a length from a value in the indicated unit.
Length	ns3::Yards (double value)
	Construct a length from a value in the indicated unit.

Detailed Description

Declaration of ns3::Length class.

Definition in file length.h.