Simulation virtual time values and global simulation resolution. More...

#include "nstime.h"

Collaboration diagram for ns3::Time:

Classes
struct	Information
	How to convert between other units and the current unit. More...

struct	Resolution
	Current time unit, and conversion info. More...

Public Types
typedef void(*	TracedCallback) (Time value)
	TracedCallback signature for Time.

enum	Unit { Y = 0 , D = 1 , H = 2 , MIN = 3 , S = 4 , MS = 5 , US = 6 , NS = 7 , PS = 8 , FS = 9 , LAST = 10 , AUTO = 11 }
	The unit to use to interpret a number representing time. More...

Public Member Functions
	Time ()
	Default constructor, with value 0.

	Time (const std::string &s)
	Construct Time object from common time expressions like "1ms".

	Time (const Time &o)
	Copy constructor.

	Time (Time &&o)
	Move constructor.

	~Time ()
	Destructor.

TimeWithUnit	As (const Unit unit=Time::AUTO) const
	Attach a unit to a Time, to facilitate output in a specific unit.

int	Compare (const Time &o) const
	Compare this to another Time.

bool	IsNegative () const
	Exactly equivalent to `t <= 0`.

bool	IsPositive () const
	Exactly equivalent to `t >= 0`.

bool	IsStrictlyNegative () const
	Exactly equivalent to `t < 0`.

bool	IsStrictlyPositive () const
	Exactly equivalent to `t > 0`.

bool	IsZero () const
	Exactly equivalent to `t == 0`.

Time &	operator= (const Time &o)
	Assignment operator.

Time	RoundTo (Unit unit) const
	Round a Time to a specific unit.

Numeric constructors
Construct from a numeric value.
	Time (double v)
	Construct from a numeric value.

	Time (int v)
	Construct from a numeric value.

	Time (long int v)
	Construct from a numeric value.

	Time (long long int v)
	Construct from a numeric value.

	Time (unsigned int v)
	Construct from a numeric value.

	Time (unsigned long int v)
	Construct from a numeric value.

	Time (unsigned long long int v)
	Construct from a numeric value.

	Time (const int64x64_t &v)
	Construct from a numeric value.

Convert to Number in a Unit
Convert a Time to number, in indicated units. Conversions to seconds and larger will return doubles, with possible loss of precision. Conversions to units smaller than seconds will be rounded.
double	GetYears () const
	Get an approximation of the time stored in this instance in the indicated unit.

double	GetDays () const
	Get an approximation of the time stored in this instance in the indicated unit.

double	GetHours () const
	Get an approximation of the time stored in this instance in the indicated unit.

double	GetMinutes () const
	Get an approximation of the time stored in this instance in the indicated unit.

double	GetSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

int64_t	GetMilliSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

int64_t	GetMicroSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

int64_t	GetNanoSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

int64_t	GetPicoSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

int64_t	GetFemtoSeconds () const
	Get an approximation of the time stored in this instance in the indicated unit.

Convert to Raw Value
Convert a Time to a number in the current resolution units.
int64_t	GetTimeStep () const
	Get the raw time value, in the current resolution unit.

double	GetDouble () const
	Get the raw time value, in the current resolution unit.

int64_t	GetInteger () const
	Get the raw time value, in the current resolution unit.

Get Times as Numbers in Specified Units
Get the Time as integers or doubles in the indicated unit.
int64_t	ToInteger (Unit unit) const
	Get the Time value expressed in a particular unit.

double	ToDouble (Unit unit) const
	Get the Time value expressed in a particular unit.

int64x64_t	To (Unit unit) const
	Get the Time value expressed in a particular unit.

Static Public Member Functions
static Time	From (const int64x64_t &value)
	Create a Time in the current unit.

static Unit	GetResolution ()

static Time	Max ()
	Maximum representable Time Not to be confused with Max(Time,Time).

static Time	Min ()
	Minimum representable Time Not to be confused with Min(Time,Time).

static void	SetResolution (Unit resolution)

static bool	StaticInit ()
	Function to force static initialization of Time.

Create Times from Values and Units
Create Times from values given in the indicated units.
static Time	FromInteger (uint64_t value, Unit unit)
	Create a Time equal to value in unit `unit`.

static Time	FromDouble (double value, Unit unit)
	Create a Time equal to value in unit `unit`.

static Time	From (const int64x64_t &value, Unit unit)
	Create a Time equal to value in unit `unit`.

Private Types
typedef std::set< Time * >	MarkedTimes
	Record all instances of Time, so we can rescale them when the resolution changes.

Static Private Member Functions
static void	Clear (Time *const time)
	Remove a Time instance from the MarkedTimes, called by ~Time().

static void	ClearMarkedTimes ()
	Remove all MarkedTimes.

static void	ConvertTimes (const Unit unit)
	Convert existing Times to the new unit.

static void	Mark (Time *const time)
	Record a Time instance with the MarkedTimes.

static bool	MarkingTimes ()
	Null check for g_markingTimes from outside time.cc.

static Information *	PeekInformation (Unit timeUnit)
	Get the Information record for timeUnit for the current Resolution.

static Resolution *	PeekResolution ()
	Get the current Resolution.

static Resolution &	SetDefaultNsResolution ()
	Set the default resolution.

static void	SetResolution (Unit unit, Resolution *resolution, const bool convert=true)
	Set the current Resolution.

Private Attributes
int64_t	m_data
	Virtual time value, in the current unit.

Static Private Attributes
static MarkedTimes *	g_markingTimes = nullptr
	Record of outstanding Time objects which will need conversion when the resolution is set.

Friends
template<class T >
std::enable_if_t< std::is_floating_point_v< T >, Time >	operator* (const Time &lhs, T rhs)
	Scale a Time by an integer value.

template<class T >
std::enable_if_t< std::is_floating_point_v< T >, Time >	operator/ (const Time &lhs, T rhs)
	Divide a Time by an integer value.

Comparison operators
bool	operator== (const Time &lhs, const Time &rhs)
	Equality operator for Time.

bool	operator!= (const Time &lhs, const Time &rhs)
	Inequality operator for Time.

bool	operator<= (const Time &lhs, const Time &rhs)
	Less than or equal operator for Time.

bool	operator>= (const Time &lhs, const Time &rhs)
	Greater than or equal operator for Time.

bool	operator< (const Time &lhs, const Time &rhs)
	Less than operator for Time.

bool	operator> (const Time &lhs, const Time &rhs)
	Greater than operator for Time.

bool	operator< (const Time &time, const EventId &event)
	Compare a Time to an EventId.

Arithmetic operators
Time	operator+ (const Time &lhs, const Time &rhs)
	Addition operator for Time.

Time	operator- (const Time &lhs, const Time &rhs)
	Subtraction operator for Time.

Time	operator* (const Time &lhs, const int64x64_t &rhs)
	Scale a Time by a numeric value.

Time	operator* (const int64x64_t &lhs, const Time &rhs)
	Scale a Time by a numeric value.

int64x64_t	operator/ (const Time &lhs, const Time &rhs)
	Exact division, returning a dimensionless fixed point number.

Time	operator/ (const Time &lhs, const int64x64_t &rhs)
	Scale a Time by a numeric value.

Time	operator% (const Time &lhs, const Time &rhs)
	Remainder (modulus) from the quotient of two Times.

int64_t	Div (const Time &lhs, const Time &rhs)
	Integer quotient from dividing two Times.

Time	Rem (const Time &lhs, const Time &rhs)
	Addition operator for Time.

template<class T >
std::enable_if_t< std::is_integral_v< T >, Time >	operator* (const Time &lhs, T rhs)
	Scale a Time by an integer value.

template<class T >
std::enable_if_t< std::is_arithmetic_v< T >, Time >	operator* (T lhs, const Time &rhs)
	Scale a Time by a numeric value.

template<class T >
std::enable_if_t< std::is_integral_v< T >, Time >	operator/ (const Time &lhs, T rhs)
	Divide a Time by an integer value.

Time	Abs (const Time &time)
	Absolute value for Time.

Time	Max (const Time &timeA, const Time &timeB)
	Maximum of two Times.

Time	Min (const Time &timeA, const Time &timeB)
	Minimum of two Times.

Compound assignment operators
Time &	operator+= (Time &lhs, const Time &rhs)
	Compound addition assignment for Time.

Time &	operator-= (Time &lhs, const Time &rhs)
	Compound subtraction assignment for Time.

Related Symbols
(Note that these are not member symbols.)
static bool	g_TimeStaticInit = Time::StaticInit()
	Force static initialization order of Time in each compilation unit.

Time	TimeStep (uint64_t ts)
	Scheduler interface.

Detailed Description

Simulation virtual time values and global simulation resolution.

This class defines all the classic C++ addition/subtraction operators: +, -, +=, -=; and all the classic comparison operators: ==, !=, <, >, <=, >=. It is thus easy to add, subtract, or compare Time objects.

For example:

Time t1 = Seconds (10.0);
Time t2 = Seconds (10.0);
Time t3 = t1;
t3 += t2;

You can also use the following non-member functions to manipulate any of these ns3::Time object:

Abs(Time)
Max(Time,Time)
Min(Time,Time)

This class also controls the resolution of the underlying time representation. The resolution is the smallest representable time interval. The default resolution is nanoseconds.

To change the resolution, use SetResolution(). All Time objects created before the call to SetResolution() will be updated to the new resolution. This can only be done once! (Tracking each Time object uses 4 pointers. For speed, once we convert the existing instances we discard the recording data structure and stop tracking new instances, so we have no way to do a second conversion.)

If you increase the global resolution, you also implicitly decrease the maximum simulation duration. The global simulation time is stored in a 64 bit integer whose interpretation will depend on the global resolution. Therefore the maximum possible duration of your simulation if you use picoseconds is 2^64 ps = 2^24 s = 7 months, whereas, had you used nanoseconds, you could have run for 584 years.

Definition at line 95 of file nstime.h.

Member Typedef Documentation

◆ MarkedTimes

typedef std::set<Time*> ns3::Time::MarkedTimes

private

Record all instances of Time, so we can rescale them when the resolution changes.

Internal:

We use a std::set so we can remove the record easily when ~Time() is called.

We don't use Ptr<Time>, because we would have to bloat every Time instance with SimpleRefCount<Time>.

Seems like this should be std::set< Time * const >, but Stack Overflow says otherwise, quoting the standard:

‍& sect;23.1/3 states that std::set key types must be assignable and copy constructable; clearly a const type will not be assignable.

Definition at line 734 of file nstime.h.

◆ TracedCallback

typedef void(* ns3::Time::TracedCallback) (Time value)

TracedCallback signature for Time.

Parameters

[in] value Current value of Time

Definition at line 656 of file nstime.h.

Member Enumeration Documentation

◆ Unit

enum ns3::Time::Unit

The unit to use to interpret a number representing time.

Enumerator
Y	year, 365 days
D	day, 24 hours
H	hour, 60 minutes
MIN	minute, 60 seconds
S	second
MS	millisecond
US	microsecond
NS	nanosecond
PS	picosecond
FS	femtosecond
LAST	marker for last normal value
AUTO	auto-scale output when using Time::As()

Definition at line 101 of file nstime.h.

Constructor & Destructor Documentation

◆ Time() [1/12]

ns3::Time::Time ( )

inline

Default constructor, with value 0.

Definition at line 129 of file nstime.h.

◆ Time() [2/12]

ns3::Time::Time ( const Time & o )

inline

Copy constructor.

Parameters

[in] o Time to copy

Definition at line 143 of file nstime.h.

ns3::Time::Time ( const std::string & s )

explicit

Construct Time object from common time expressions like "1ms".

Supported units include:

s (seconds)
ms (milliseconds)
us (microseconds)
ns (nanoseconds)
ps (picoseconds)
fs (femtoseconds)
min (minutes)
h (hours)
d (days)
y (years)

There must be no whitespace between the numerical portion and the unit. If the string only contains a number, it is treated as seconds. Any otherwise malformed string causes a fatal error to occur.

Parameters

[in] s The string to parse into a Time

Definition at line 118 of file time.cc.

References D, FromDouble(), FS, H, Mark(), MarkingTimes(), MIN, MS, NS, NS_ABORT_MSG, NS_LOG_FUNCTION, PS, S, US, and Y.

Here is the call graph for this function:

◆ ~Time()

ns3::Time::~Time ( )

inline

Destructor.

Definition at line 294 of file nstime.h.

Member Function Documentation

◆ As()

TimeWithUnit ns3::Time::As ( const Unit unit = Time::AUTO ) const

Attach a unit to a Time, to facilitate output in a specific unit.

For example,

Time t (3.14e9); // Pi seconds

std::cout << t.As (Time::MS) << std::endl;

ns3::Time::MS

@ MS

millisecond

Definition nstime.h:108

will print +3140.0ms

Parameters

[in] unit The unit to use.

Returns: The Time with embedded unit.

Definition at line 409 of file time.cc.

◆ Clear()

void ns3::Time::Clear ( Time *const time )

staticprivate

Remove a Time instance from the MarkedTimes, called by ~Time().

Parameters

[in] time The Time instance to remove.

Definition at line 343 of file time.cc.

References ns3::g_markingMutex, g_markingTimes, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and NS_LOG_WARN.

◆ ClearMarkedTimes()

void ns3::Time::ClearMarkedTimes ( )

staticprivate

Remove all MarkedTimes.

Internal:: Has to be visible to the Simulator class, hence the friending.

Internal:

We're called by Simulator::Run, which knows nothing about the mutex, so we need a critical section here.

It would seem natural to use this function at the end of ConvertTimes, but that function already has the mutex. The mutex can not be locked more than once in the same thread, so calling this function from ConvertTimes is a bad idea.

Instead, we copy this body into ConvertTimes.

Definition at line 291 of file time.cc.

References ns3::g_markingMutex, g_markingTimes, NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.

Referenced by ns3::Simulator::Run().

Here is the caller graph for this function:

◆ Compare()

int ns3::Time::Compare ( const Time & o ) const

inline

Compare this to another Time.

Parameters

[in] o The other Time

Returns: -1,0,+1 if this < o, this == o, or this > o

Definition at line 353 of file nstime.h.

References m_data.

◆ ConvertTimes()

void ns3::Time::ConvertTimes ( const Unit unit )

staticprivate

Convert existing Times to the new unit.

Parameters

[in] unit The Unit to convert existing Times to.

Definition at line 371 of file time.cc.

References ns3::g_markingMutex, g_markingTimes, m_data, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and ToInteger().

Referenced by SetResolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ From() [1/2]

static Time ns3::Time::From ( const int64x64_t & value )

inlinestatic

Create a Time in the current unit.

Parameters

[in] value The value of the new Time.

Returns: A Time with value in the current time unit.

Definition at line 472 of file nstime.h.

Referenced by ns3::Days(), RttEstimatorTestCase::DoRun(), ns3::FemtoSeconds(), ns3::Hours(), ns3::RttMeanDeviation::IntegerUpdate(), ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::Minutes(), ns3::NanoSeconds(), ns3::PicoSeconds(), ns3::Seconds(), and ns3::Years().

Here is the caller graph for this function:

◆ From() [2/2]

static Time ns3::Time::From	(	const int64x64_t &	value,
		Unit	unit )

inlinestatic

Create a Time equal to value in unit unit.

Parameters

[in]	value	The new Time value, expressed in `unit`
[in]	unit	The unit of value

Returns: The Time representing value in unit

Definition at line 524 of file nstime.h.

References ns3::Time::Information::fromMul, ns3::Time::Information::isValid, ns3::int64x64_t::MulByInvert(), NS_ASSERT_MSG, and ns3::Time::Information::timeFrom.

Here is the call graph for this function:

◆ FromDouble()

static Time ns3::Time::FromDouble	(	double	value,
		Unit	unit )

inlinestatic

Create a Time equal to value in unit unit.

Parameters

[in]	value	The new Time value, expressed in `unit`
[in]	unit	The unit of value

Returns: The Time representing value in unit

Definition at line 513 of file nstime.h.

Referenced by Time(), ns3::Days(), ns3::RttMeanDeviation::FloatingPointUpdate(), ns3::Hours(), ns3::Minutes(), ns3::TcpSocketBase::ReTxTimeout(), ns3::Seconds(), and ns3::Years().

Here is the caller graph for this function:

◆ FromInteger()

static Time ns3::Time::FromInteger	(	uint64_t	value,
		Unit	unit )

inlinestatic

Create a Time equal to value in unit unit.

Parameters

[in]	value	The new Time value, expressed in `unit`
[in]	unit	The unit of value

Returns: The Time representing value in unit

Definition at line 490 of file nstime.h.

References ns3::Time::Information::factor, ns3::Time::Information::fromMul, ns3::Time::Information::isValid, and NS_ASSERT_MSG.

Referenced by ns3::FemtoSeconds(), ns3::Ipv4ClickRouting::HandleScheduleFromClick(), ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::NanoSeconds(), and ns3::PicoSeconds().

Here is the caller graph for this function:

◆ GetDays()

double ns3::Time::GetDays ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 379 of file nstime.h.

◆ GetDouble()

double ns3::Time::GetDouble ( ) const

inline

Get the raw time value, in the current resolution unit.

Returns: The raw time value

Definition at line 441 of file nstime.h.

Referenced by ns3::WifiCoTraceHelper::ComputePercentage(), TimeSimpleTestCase::TestMultiplicationByDecimalTypes(), and ns3::TcpHtcp::UpdateBeta().

Here is the caller graph for this function:

◆ GetFemtoSeconds()

int64_t ns3::Time::GetFemtoSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 419 of file nstime.h.

Referenced by DataRateTestCase::CheckTimesEqual(), ns3::HtPhy::GetPayloadDuration(), ns3::OfdmPhy::GetPayloadDuration(), and ns3::Ipv4ClickRouting::GetTimevalFromNow().

Here is the caller graph for this function:

◆ GetHours()

double ns3::Time::GetHours ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 384 of file nstime.h.

Referenced by GraphBattery5().

Here is the caller graph for this function:

◆ GetInteger()

int64_t ns3::Time::GetInteger ( ) const

inline

Get the raw time value, in the current resolution unit.

Returns: The raw time value

Definition at line 446 of file nstime.h.

Referenced by ns3::DistributedSimulatorImpl::CalculateLookAhead(), RttEstimatorTestCase::DoRun(), TimeSimpleTestCase::DoRun(), ns3::RttMeanDeviation::IntegerUpdate(), ns3::NullMessageMpiInterface::SendNullMessage(), ns3::GrantedTimeWindowMpiInterface::SendPacket(), ns3::NullMessageMpiInterface::SendPacket(), and anonymous_namespace{traced-value-callback-typedef-test-suite.cc}::TracedValueCbSink< Time >().

Here is the caller graph for this function:

◆ GetMicroSeconds()

int64_t ns3::Time::GetMicroSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 404 of file nstime.h.

Referenced by ns3::dot11s::IeBeaconTiming::BeaconIntervalToU16(), OfdmaAckSequenceTest::CheckResults(), CheckT1QueueSize(), CheckT2QueueSize(), CoDelQueueDiscBasicDrop::Dequeue(), CoDelQueueDiscBasicMark::Dequeue(), ns3::ApWifiMac::DoInitialize(), LrWpanSlottedCsmacaTestCase::DoRun(), ns3::CommonInfoBasicMle::EncodeEmlsrPaddingDelay(), ns3::CommonInfoBasicMle::EncodeEmlsrTransitionDelay(), ns3::dot11s::HwmpProtocol::GetActivePathLifetime(), ns3::ApWifiMac::GetEdcaParameterSet(), ns3::TidToLinkMapping::GetMappingSwitchTime(), ns3::Ipv4ClickRouting::GetTimevalFromNow(), Ns3TcpLossTestCase::Ipv4L3Tx(), Ns3TcpStateTestCase::Ipv4L3Tx(), PacketDequeue(), PrintIntermediateTput(), ns3::MinstrelWifiManager::PrintTable(), ns3::dot11s::HwmpProtocol::ReceivePreq(), PingTestCase::ReportTraceSink(), ns3::MeshWifiInterfaceMac::SendBeacon(), ns3::dot11s::HwmpProtocol::SendProactivePreq(), ns3::dot11s::PeerLink::SetBeaconInformation(), ns3::ApWifiMac::SetBeaconInterval(), ns3::dot11s::PeerLink::SetConfirmTimer(), ns3::DsssPpdu::SetDsssHeader(), ns3::TidToLinkMapping::SetExpectedDuration(), ns3::dot11s::PeerLink::SetHoldingTimer(), ns3::TidToLinkMapping::SetMappingSwitchTime(), ns3::CommonInfoBasicMle::SetMediumSyncDelayTimer(), ns3::MuEdcaParameterSet::SetMuEdcaTimer(), ns3::dot11s::PeerLink::SetRetryTimer(), ns3::MultiLinkElement::SetTransitionTimeout(), ns3::Txop::SetTxopLimit(), ns3::MinstrelHtWifiManager::StatsDump(), ns3::dot11s::IeBeaconTiming::TimestampToU16(), ns3::MinstrelWifiManager::UpdateStats(), ns3::PcapFileWrapper::Write(), ns3::PcapFileWrapper::Write(), and ns3::PcapFileWrapper::Write().

Here is the caller graph for this function:

◆ GetMilliSeconds()

int64_t ns3::Time::GetMilliSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 399 of file nstime.h.

Referenced by ns3::aodv::RrepHeader::RrepHeader(), ns3::PieQueueDisc::CalculateP(), ns3::TcpLedbat::CongestionAvoidance(), ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), ns3::PieQueueDisc::DoEnqueue(), ThreeGppAntennaSetupChangedTest::DoGetChannel(), ThreeGppChannelMatrixUpdateTest::DoGetChannel(), ns3::A3RsrpHandoverAlgorithm::DoInitialize(), ns3::LteRlcAm::DoReportBufferStatus(), ns3::LteRlcTm::DoReportBufferStatus(), ns3::LteRlcUm::DoReportBufferStatus(), LenaDataPhyErrorModelTestCase::DoRun(), LenaDlCtrlPhyErrorModelTestCase::DoRun(), LteUeMeasurementsHandoverTestCase::DoRun(), Ns3TcpCubicTestCase::DoRun(), ns3::TcpOptionTS::ElapsedTimeFromTsValue(), ns3::LteSpectrumPhy::EndRxData(), LteHandoverTargetTestCase::HandoverStartCallback(), ns3::TcpYeah::IncreaseWindow(), TcpVegasTest::IncreaseWindow(), ns3::TraceFadingLossModel::LoadTrace(), ns3::TcpOptionTS::NowToTsValue(), PingRtt(), ns3::TcpLp::PktsAcked(), ns3::TcpYeah::PktsAcked(), ns3::TcpHybla::RecalcParam(), ns3::TcpIllinois::RecalcParam(), TcpIllinoisTest::RecalcParam(), ns3::LteUePhy::ReceiveLteControlMessageList(), LteUeMeasurementsHandoverTestCase::RecvMeasurementReportCallback(), LteUeMeasurementsPiecewiseTestCase1::RecvMeasurementReportCallback(), LteUeMeasurementsPiecewiseTestCase2::RecvMeasurementReportCallback(), LteUeMeasurementsPiecewiseTestCase3::RecvMeasurementReportCallback(), ns3::UanHeaderRcCts::Serialize(), ns3::UanHeaderRcCtsGlobal::Serialize(), ns3::UanHeaderRcData::Serialize(), ns3::UanHeaderRcRts::Serialize(), ns3::aodv::RrepHeader::SetHello(), ns3::aodv::RrepHeader::SetLifeTime(), and ns3::LteEnbPhy::StartSubFrame().

Here is the caller graph for this function:

◆ GetMinutes()

double ns3::Time::GetMinutes ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 389 of file nstime.h.

Referenced by GraphBattery1(), GraphBattery2(), and GraphBattery4().

Here is the caller graph for this function:

◆ GetNanoSeconds()

int64_t ns3::Time::GetNanoSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 409 of file nstime.h.

Referenced by ns3::CtrlTriggerHeader::CtrlTriggerHeader(), ns3::OfdmPhy::CalculateDataRate(), ns3::AcousticModemEnergyModel::ChangeState(), ns3::CoDelGetTime(), ns3::HePhy::ConvertHeTbPpduDurationToLSigLength(), CobaltQueueDiscMarkTest::Dequeue(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::LtePdcp::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), ns3::LteRlcUm::DoReceivePdu(), TimeInputOutputTestCase::DoRun(), anonymous_namespace{sample-show-progress.cc}::Hold::Event(), ns3::EhtPhy::GetDataRate(), ns3::HePhy::GetDataRate(), ns3::HtPhy::GetDataRate(), ns3::VhtPhy::GetDataRate(), ns3::HePpdu::GetGuardIntervalAndNltfEncoding(), ns3::HtPhy::GetNumberBccEncoders(), ns3::VhtPhy::GetNumberBccEncoders(), ns3::HtPhy::GetPayloadDuration(), ns3::OfdmPhy::GetPayloadDuration(), ns3::HePhy::GetSymbolDuration(), ns3::HtPhy::GetSymbolDuration(), ns3::Ipv4ClickRouting::GetTimevalFromNow(), SimulatorEventsTestCase::NowUs(), ns3::PdcpTag::Serialize(), ns3::RlcTag::Serialize(), ns3::WifiMacHeader::SetDuration(), ns3::CtrlTriggerHeader::SetGiAndLtfType(), ns3::HeConfiguration::SetGuardInterval(), ns3::HtPpdu::SetHtSigHeader(), ns3::HePpdu::SetLSigHeader(), ns3::HtPpdu::SetLSigHeader(), ns3::VhtPpdu::SetLSigHeader(), ns3::HePhy::SetTrigVector(), ns3::VhtPpdu::SetVhtSigHeader(), ns3::CobaltQueueDisc::Time2CoDel(), ns3::CoDelQueueDisc::Time2CoDel(), ns3::energy::BasicEnergyHarvester::UpdateHarvestedPower(), ns3::PcapFileWrapper::Write(), ns3::PcapFileWrapper::Write(), and ns3::PcapFileWrapper::Write().

Here is the caller graph for this function:

◆ GetPicoSeconds()

int64_t ns3::Time::GetPicoSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 414 of file nstime.h.

Referenced by ns3::Ipv4ClickRouting::GetTimevalFromNow().

Here is the caller graph for this function:

◆ GetResolution()

Time::Unit ns3::Time::GetResolution ( )

static

Returns: The current global resolution.

Definition at line 402 of file time.cc.

References PeekResolution(), and ns3::Time::Resolution::unit.

Referenced by ns3::DefaultTimePrinter(), DataRateTestCase1::DoRun(), and ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSeconds()

double ns3::Time::GetSeconds ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 394 of file nstime.h.

◆ GetTimeStep()

int64_t ns3::Time::GetTimeStep ( ) const

inline

Get the raw time value, in the current resolution unit.

Returns: The raw time value

Definition at line 436 of file nstime.h.

Here is the caller graph for this function:

◆ GetYears()

double ns3::Time::GetYears ( ) const

inline

Get an approximation of the time stored in this instance in the indicated unit.

Returns: An approximate value in the indicated unit.

Definition at line 374 of file nstime.h.

◆ IsNegative()

bool ns3::Time::IsNegative ( ) const

inline

Exactly equivalent to t <= 0.

Returns: true if the time is negative or zero, false otherwise.

Definition at line 315 of file nstime.h.

Referenced by ns3::ShowProgress::CheckProgress(), ns3::RandomWalk2dOutdoorMobilityModel::DoWalk(), ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits(), ns3::UanPdp::SumTapsC(), ns3::UanPdp::SumTapsFromMaxC(), ns3::UanPdp::SumTapsFromMaxNc(), ns3::UanPdp::SumTapsNc(), and ns3::RrMultiUserScheduler::TrySendingBasicTf().

Here is the caller graph for this function:

◆ IsPositive()

bool ns3::Time::IsPositive ( ) const

inline

Exactly equivalent to t >= 0.

Returns: true if the time is positive or zero, false otherwise.

Definition at line 324 of file nstime.h.

Referenced by ThreeGppHttpObjectTestCase::ThreeGppHttpObjectTestCase(), ns3::energy::BasicEnergySource::CalculateRemainingEnergy(), ns3::WifiCoTraceHelper::NotifyWifiPhyState(), ns3::TcpLedbat::PktsAcked(), ns3::DefaultSimulatorImpl::Schedule(), ns3::DistributedSimulatorImpl::Schedule(), ns3::NullMessageSimulatorImpl::Schedule(), ns3::RealtimeSimulatorImpl::Schedule(), ns3::NullMessageSimulatorImpl::ScheduleWithContext(), ns3::Txop::SetTxopLimit(), ns3::UanPdp::SumTapsC(), and ns3::UanPdp::SumTapsNc().

Here is the caller graph for this function:

◆ IsStrictlyNegative()

bool ns3::Time::IsStrictlyNegative ( ) const

inline

Exactly equivalent to t < 0.

Returns: true if the time is strictly negative, false otherwise.

Definition at line 333 of file nstime.h.

Referenced by ns3::FrameExchangeManager::DoSendCtsAfterRts(), ns3::QosTxop::GetRemainingTxop(), ns3::aodv::IsExpired::operator()(), ns3::dsdv::IsExpired::operator()(), ns3::dsr::IsExpired::operator()(), ns3::dsr::IsExpired::operator()(), ns3::dsr::IsExpired::operator()(), ns3::dsr::IsExpired::operator()(), ns3::UanMacRc::ScheduleData(), ns3::HtFrameExchangeManager::SendBlockAck(), and ns3::FrameExchangeManager::SendNormalAck().

Here is the caller graph for this function:

◆ IsStrictlyPositive()

bool ns3::Time::IsStrictlyPositive ( ) const

inline

Exactly equivalent to t > 0.

Returns: true if the time is strictly positive, false otherwise.

Definition at line 342 of file nstime.h.

Referenced by ns3::MultiUserScheduler::AccessReqTimeout(), ns3::dsr::DsrRouteCache::AddRoute(), ns3::DistributedSimulatorImpl::BoundLookAhead(), ns3::HePhy::CalculateTxDuration(), ns3::WifiPhy::CalculateTxDuration(), EmlsrDlTxopTest::CheckInitialControlFrame(), ns3::PieQueueDisc::DoDequeue(), ns3::MultiUserScheduler::DoInitialize(), LrWpanAckTestCase::DoRun(), LteHandoverDelayTestCase::EnbHandoverEndOkCallback(), ns3::PhyEntity::GetCcaIndication(), ns3::EhtPhy::GetCcaIndicationOnSecondary(), ns3::HtPhy::GetCcaIndicationOnSecondary(), ns3::aodv::RoutingProtocol::HelloTimerExpire(), ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits(), ns3::olsr::RoutingProtocol::LinkSensing(), ns3::WifiRemoteStationManager::NeedRts(), ns3::MultiUserScheduler::NotifyAccessGranted(), TestPhyListener::NotifyCcaBusyStart(), ns3::StaWifiMac::NotifySwitchingEmlsrLink(), ns3::HeFrameExchangeManager::ProtectionCompleted(), ns3::NullMessageMpiInterface::ReceiveMessages(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::Ipv4L3Protocol::RemoveDuplicates(), ns3::FlowMonitor::ReportLastRx(), ns3::FrameExchangeManager::RxStartIndication(), ns3::MultiUserScheduler::SetAccessReqInterval(), ns3::MuEdcaParameterSet::SetMuEdcaTimer(), ns3::QosFrameExchangeManager::StartTransmission(), ns3::DefaultEmlsrManager::SwitchAuxPhyAfterMainPhy(), ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy(), ns3::QosFrameExchangeManager::TransmissionFailed(), ns3::QosFrameExchangeManager::TransmissionSucceeded(), LteHandoverDelayTestCase::UeHandoverEndOkCallback(), ns3::Ipv4L3Protocol::UpdateDuplicate(), and ns3::EhtFrameExchangeManager::UpdateTxopEndOnRxStartIndication().

Here is the caller graph for this function:

◆ IsZero()

bool ns3::Time::IsZero ( ) const

inline

Exactly equivalent to t == 0.

Returns: true if the time is zero, false otherwise.

Definition at line 306 of file nstime.h.

Referenced by ns3::IdentifierOption::IdentifierOption(), ns3::SixLowPanNetDevice::AddContext(), ns3::InterferenceHelper::CalculateChunkSuccessRate(), ns3::InterferenceHelper::CalculatePayloadChunkSuccessRate(), ns3::TcpSocketBase::CalculateRttSample(), ns3::ThreeGppChannelModel::ChannelParamsNeedsUpdate(), EmlsrDlTxopTest::CheckBlockAck(), EmlsrUlTxopTest::CheckCtsFrames(), EmlsrDlTxopTest::CheckQosFrames(), GcrBaTest::CheckResults(), EmlsrUlTxopTest::CheckRtsFrames(), ns3::WifiCoTraceHelper::ComputePercentage(), ns3::FdNetDevice::DoInitialize(), WifiPrimaryChannelsTest::DoSendHeTbPpdu(), ns3::EhtFrameExchangeManager::EmlsrSwitchToListening(), ns3::TrickleTimer::Enable(), ns3::TcpWestwoodPlus::EstimateBW(), ns3::TcpSocketBase::EstimateRtt(), ns3::TcpRateLinux::GenerateSample(), ns3::ThreeGppChannelConditionModel::GetChannelCondition(), ns3::QosFrameExchangeManager::GetCtsToSelfDurationId(), ns3::QosFrameExchangeManager::GetFrameDurationId(), ns3::ApWifiMac::GetMuEdcaParameterSet(), ns3::HeFrameExchangeManager::GetMuRtsDurationId(), ns3::HtFrameExchangeManager::GetPsduDurationId(), ns3::QosFrameExchangeManager::GetRtsDurationId(), ns3::dsdv::RoutingProtocol::GetSettlingTime(), ns3::TcpBbr::HandleProbeRTT(), ns3::Icmpv6L4Protocol::HandleRsTimeout(), ns3::Probe::IsEnabled(), ns3::TcpRateOps::TcpRateSample::IsValid(), ns3::lrwpan::LrWpanMac::PdDataConfirm(), ns3::TcpIllinois::PktsAcked(), ns3::TcpLp::PktsAcked(), ns3::TcpVegas::PktsAcked(), ns3::TcpVeno::PktsAcked(), ns3::TcpWestwoodPlus::PktsAcked(), ns3::TcpYeah::PktsAcked(), GcrBaTest::Receive(), ns3::ThreeGppHttpClient::ReceiveEmbeddedObject(), ns3::ofi::LearningController::ReceiveFromSwitch(), ns3::ThreeGppHttpClient::ReceiveMainObject(), ns3::flame::FlameProtocol::RemoveRoutingStuff(), ns3::PhyEntity::ScheduleEndOfMpdus(), ns3::PacketSocketClient::Send(), ns3::LteTestMac::SendTxOpportunity(), ns3::dot11s::PeerManagementProtocolMac::SetBeaconShift(), ns3::LteTestMac::SetTxOpportunityMode(), ns3::LteTestRrc::Start(), EmlsrDlTxopTest::StartTraffic(), ns3::QosFrameExchangeManager::StartTransmission(), ns3::UanPdp::SumTapsFromMaxC(), ns3::UanPdp::SumTapsFromMaxNc(), ns3::WifiPhyStateHelper::SwitchToChannelSwitching(), ns3::HeFrameExchangeManager::TransmissionSucceeded(), ns3::HtFrameExchangeManager::TransmissionSucceeded(), EmlsrUlOfdmaTest::Transmit(), GcrBaTest::Transmit(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), PingTestCase::TxTraceSink(), and ns3::TcpBbr::UpdateBottleneckBandwidth().

Here is the caller graph for this function:

◆ Mark()

void ns3::Time::Mark ( Time *const time )

staticprivate

Record a Time instance with the MarkedTimes.

Parameters

[in] time The Time instance to record.

Definition at line 320 of file time.cc.

References ns3::g_markingMutex, g_markingTimes, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and NS_LOG_WARN.

Referenced by Time().

Here is the caller graph for this function:

◆ MarkingTimes()

bool ns3::Time::MarkingTimes ( )

staticprivate

Null check for g_markingTimes from outside time.cc.

Returns: true if g_markingTimes is not null

Internal:

The inline Time ctors need to check if g_markingTimes is allocated before calling Mark(). Likewise, the dtor also needs to check before calling Clear(). On Windows, attempting to access g_markingTimes directly from outside the compilation unit is an access violation so this method is provided to work around that limitation.

Definition at line 284 of file time.cc.

References g_markingTimes.

Referenced by Time().

Here is the caller graph for this function:

◆ Max()

static Time ns3::Time::Max ( )

inlinestatic

Maximum representable Time Not to be confused with Max(Time,Time).

Returns: the maximum representable Time.

Definition at line 288 of file nstime.h.

Referenced by ns3::FqCobaltQueueDisc::CheckConfig(), ns3::FqCoDelQueueDisc::CheckConfig(), ns3::FqPieQueueDisc::CheckConfig(), ns3::TcpBbr::CongestionStateSet(), ns3::PieQueueDisc::DoEnqueue(), ns3::WifiMacQueue::DoEnqueue(), CobaltQueueDiscBasicEnqueueDequeue::DoRun(), CobaltQueueDiscCeThresholdTest::DoRun(), CobaltQueueDiscEnhancedBlueTest::DoRun(), CobaltQueueDiscMarkTest::DoRun(), FqCobaltQueueDiscEcnMarking::DoRun(), ns3::TcpVegas::EnableVegas(), ns3::TcpVeno::EnableVeno(), ns3::TcpYeah::EnableYeah(), ns3::TcpHtcp::GetSsThresh(), ns3::FlowMonitor::GetStatsForFlow(), ns3::ArpCache::Entry::GetTimeout(), ns3::CobaltQueueDisc::GetTypeId(), ns3::CoDelQueueDisc::GetTypeId(), ns3::FqCobaltQueueDisc::GetTypeId(), ns3::FqCoDelQueueDisc::GetTypeId(), ns3::FqPieQueueDisc::GetTypeId(), ns3::PieQueueDisc::GetTypeId(), ns3::TcpVegas::IncreaseWindow(), ns3::TcpVeno::IncreaseWindow(), ns3::TcpYeah::IncreaseWindow(), ns3::TcpBbr::InFlight(), ns3::TcpBbr::InitPacingRate(), ns3::MakeTimeChecker(), ns3::MakeTimeChecker(), ns3::Dhcp6Client::ProcessReply(), CobaltQueueDiscDropTest::RunDropTest(), ns3::TcpBbr::SetPacingRate(), ns3::TcpRateLinux::SkbDelivered(), and TcpRateLinuxBasicTest::SkbDelivered().

Here is the caller graph for this function:

◆ Min()

static Time ns3::Time::Min ( )

inlinestatic

Minimum representable Time Not to be confused with Min(Time,Time).

Returns: the minimum representable Time.

Definition at line 278 of file nstime.h.

Referenced by ns3::RrMultiUserScheduler::ComputeDlMuInfo(), ns3::TcpCubic::CubicReset(), AmpduAggregationTest::DoRun(), EhtAggregationTest::DoRun(), HeAggregationTest::DoRun(), TwoLevelAggregationTest::DoRun(), ns3::QosTxop::GetNextMpdu(), ns3::TcpBic::GetSsThresh(), ns3::TcpCubic::GetSsThresh(), ns3::TcpHtcp::GetSsThresh(), ns3::TcpCubic::HystartReset(), ns3::TcpCubic::HystartUpdate(), ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits(), ns3::MakeTimeChecker(), ns3::QosTxop::NotifyChannelAccessed(), ns3::TcpCubic::PktsAcked(), TestMultiUserScheduler::SelectTxFormat(), ns3::QosFrameExchangeManager::StartTransmission(), ns3::QosFrameExchangeManager::TryAddMpdu(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), ns3::RrMultiUserScheduler::TrySendingDlMuPpdu(), ns3::TcpBic::Update(), and ns3::TcpCubic::Update().

Here is the caller graph for this function:

◆ operator=()

Time & ns3::Time::operator= ( const Time & o )

inline

Assignment operator.

Parameters

[in] o Time to assign.

Returns: The Time.

Definition at line 122 of file nstime.h.

References m_data.

◆ PeekInformation()

static Information * ns3::Time::PeekInformation ( Unit timeUnit )

inlinestaticprivate

Get the Information record for timeUnit for the current Resolution.

Parameters

[in] timeUnit The Unit to get Information for

Returns: The Information for timeUnit

Definition at line 694 of file nstime.h.

◆ PeekResolution()

static Resolution * ns3::Time::PeekResolution ( )

inlinestaticprivate

Get the current Resolution.

Returns: A pointer to the current Resolution

Definition at line 682 of file nstime.h.

Referenced by GetResolution(), and SetResolution().

Here is the caller graph for this function:

◆ RoundTo()

Time ns3::Time::RoundTo ( Unit unit ) const

inline

Round a Time to a specific unit.

Rounding is to nearest integer.

Parameters

[in] unit The unit to round to.

Returns: The Time rounded to the specific unit.

Definition at line 631 of file nstime.h.

Referenced by ns3::UanHeaderRcCts::Serialize(), ns3::UanHeaderRcCtsGlobal::Serialize(), ns3::UanHeaderRcData::Serialize(), and ns3::UanHeaderRcRts::Serialize().

Here is the caller graph for this function:

◆ SetDefaultNsResolution()

Time::Resolution & ns3::Time::SetDefaultNsResolution ( )

staticprivate

Set the default resolution.

Returns: The Resolution object for the default resolution.

Definition at line 192 of file time.cc.

References NS, NS_LOG_FUNCTION_NOARGS, and SetResolution().

Here is the call graph for this function:

◆ SetResolution() [1/2]

void ns3::Time::SetResolution ( Unit resolution )

static

Parameters

[in] resolution The new resolution to use

Change the global resolution used to convert all user-provided time values in Time objects and Time objects in user-expected time units.

Definition at line 202 of file time.cc.

References NS_LOG_FUNCTION, PeekResolution(), and SetResolution().

Referenced by AttributeTestCase< T >::DoRun(), DataRateTestCase1::DoRun(), TimeSimpleTestCase::DoRun(), SetDefaultNsResolution(), and SetResolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetResolution() [2/2]

void ns3::Time::SetResolution	(	Unit	unit,
		Resolution *	resolution,
		const bool	convert = true )

staticprivate

Set the current Resolution.

Parameters

[in]	unit	The unit to use as the new resolution.
[in,out]	resolution	The Resolution record to update.
[in]	convert	Whether to convert existing Time objects to the new resolution.

Definition at line 210 of file time.cc.

References ConvertTimes(), ns3::Time::Information::factor, ns3::Time::Information::fromMul, ns3::Time::Resolution::info, ns3::int64x64_t::Invert(), ns3::Time::Information::isValid, LAST, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::Information::timeFrom, ns3::Time::Information::timeTo, ns3::Time::Information::toMul, and ns3::Time::Resolution::unit.

Here is the call graph for this function:

◆ StaticInit()

bool ns3::Time::StaticInit ( )

static

Function to force static initialization of Time.

Returns: true on the first call

Definition at line 86 of file time.cc.

References ns3::g_markingMutex, g_markingTimes, and NS_LOG_ERROR.

◆ To()

int64x64_t ns3::Time::To ( Unit unit ) const

inline

Get the Time value expressed in a particular unit.

Parameters

[in] unit The desired unit

Returns: The Time expressed in unit

Definition at line 599 of file nstime.h.

References ns3::Time::Information::isValid, ns3::int64x64_t::MulByInvert(), NS_ASSERT_MSG, ns3::Time::Information::timeTo, and ns3::Time::Information::toMul.

Here is the call graph for this function:

◆ ToDouble()

double ns3::Time::ToDouble ( Unit unit ) const

inline

Get the Time value expressed in a particular unit.

Parameters

[in] unit The desired unit

Returns: The Time expressed in unit

Definition at line 588 of file nstime.h.

Referenced by ns3::RttMeanDeviation::FloatingPointUpdate(), Ipv4DeduplicationTest::MakeName(), SojournTimeTrace(), and ns3::RrMultiUserScheduler::UpdateCredits().

Here is the caller graph for this function:

◆ ToInteger()

int64_t ns3::Time::ToInteger ( Unit unit ) const

inline

Get the Time value expressed in a particular unit.

Parameters

[in] unit The desired unit

Returns: The Time expressed in unit

Definition at line 564 of file nstime.h.

References ns3::Time::Information::factor, ns3::Time::Information::isValid, NS_ASSERT_MSG, and ns3::Time::Information::toMul.

Referenced by ConvertTimes(), and Experiment::Run().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ Abs

Time Abs ( const Time & time )

friend

Absolute value for Time.

Parameters

[in] time The Time value

Returns: The absolute value of the input.

Definition at line 1241 of file nstime.h.

◆ Div

int64_t Div	(	const Time &	lhs,
		const Time &	rhs )

friend

Integer quotient from dividing two Times.

This is the same as the "normal" C++ integer division, which truncates (discarding any remainder).

As usual, if ta, and tb are both Times

ta  ==  tb * Div (ta, tb) + Rem (ta, tb);
 
ta  ==  tb * (ta / tb).GetHigh()  + ta % tb;

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The integer portion of lhs / rhs.

See also: Rem()

Definition at line 1204 of file nstime.h.

◆ g_TimeStaticInit

bool g_TimeStaticInit = Time::StaticInit()

This is internal to the Time implementation.

Definition at line 891 of file nstime.h.

◆ Max

Time Max	(	const Time &	timeA,
		const Time &	timeB )

friend

Maximum of two Times.

Parameters

[in]	timeA	The first value
[in]	timeB	The second value

Returns: The larger of the two operands.

Definition at line 1253 of file nstime.h.

◆ Min

Time Min	(	const Time &	timeA,
		const Time &	timeB )

friend

Minimum of two Times.

Parameters

[in]	timeA	The first value
[in]	timeB	The second value

Returns: The smaller of the two operands.

Definition at line 1265 of file nstime.h.

◆ operator!=

bool operator!=	(	const Time &	lhs,
		const Time &	rhs )

friend

Inequality operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the two input values not are equal.

Definition at line 912 of file nstime.h.

◆ operator%

Time operator%	(	const Time &	lhs,
		const Time &	rhs )

friend

Remainder (modulus) from the quotient of two Times.

Rem() and operator% are equivalent:

Rem (ta, tb)  ==  ta % tb;

See also: Div()

Parameters

[in]	lhs	The first time value
[in]	rhs	The second time value

Returns: The remainder of lhs / rhs.

Definition at line 1170 of file nstime.h.

◆ operator* [1/5]

Time operator*	(	const int64x64_t &	lhs,
		const Time &	rhs )

friend

Scale a Time by a numeric value.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The Time scaled by the other operand.

Definition at line 1039 of file nstime.h.

◆ operator* [2/5]

Time operator*	(	const Time &	lhs,
		const int64x64_t &	rhs )

friend

Scale a Time by a numeric value.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The Time scaled by the other operand.

Definition at line 1025 of file nstime.h.

◆ operator* [3/5]

template<class T >

std::enable_if_t< std::is_integral_v< T >, Time > operator*	(	const Time &	lhs,
		T	rhs )

friend

Scale a Time by an integer value.

Template Parameters

T	Integer data type (int, long, etc.)

Parameters

[in]	lhs	The Time instance to scale
[in]	rhs	The scale value

Returns: A new Time instance containing the scaled value

Definition at line 1055 of file nstime.h.

◆ operator* [4/5]

template<class T >

std::enable_if_t< std::is_floating_point_v< T >, Time > operator*	(	const Time &	lhs,
		T	rhs )

friend

Scale a Time by an integer value.

Template Parameters

T	Integer data type (int, long, etc.)

Parameters

[in]	lhs	The Time instance to scale
[in]	rhs	The scale value

Returns: A new Time instance containing the scaled value

Definition at line 1055 of file nstime.h.

◆ operator* [5/5]

template<class T >

std::enable_if_t< std::is_arithmetic_v< T >, Time > operator*	(	T	lhs,
		const Time &	rhs )

friend

Scale a Time by a numeric value.

This overload handles the case where the scale value comes before the Time value. It swaps the arguments so that the Time argument comes first and calls the appropriate overload of operator*

Template Parameters

T	Arithmetic data type (int, long, float, etc.)

Parameters

[in]	lhs	The scale value
[in]	rhs	The Time instance to scale

Returns: A new Time instance containing the scaled value

Definition at line 1085 of file nstime.h.

◆ operator+

Time operator+	(	const Time &	lhs,
		const Time &	rhs )

friend

Addition operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The sum of the two input values.

Definition at line 1001 of file nstime.h.

◆ operator+=

Time & operator+=	(	Time &	lhs,
		const Time &	rhs )

friend

Compound addition assignment for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The sum of the two inputs.

Definition at line 1216 of file nstime.h.

◆ operator-

Time operator-	(	const Time &	lhs,
		const Time &	rhs )

friend

Subtraction operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The difference of the two input values.

Definition at line 1013 of file nstime.h.

◆ operator-=

Time & operator-=	(	Time &	lhs,
		const Time &	rhs )

friend

Compound subtraction assignment for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The difference of the two operands.

Definition at line 1229 of file nstime.h.

◆ operator/ [1/4]

Time operator/	(	const Time &	lhs,
		const int64x64_t &	rhs )

friend

Scale a Time by a numeric value.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The Time divided by the scalar operand.

Definition at line 1123 of file nstime.h.

◆ operator/ [2/4]

int64x64_t operator/	(	const Time &	lhs,
		const Time &	rhs )

friend

Exact division, returning a dimensionless fixed point number.

This can be truncated to integer, or converted to double (with loss of precision). Assuming ta and tb are Times:

int64x64_t ratio = ta / tb;
 
int64_t i = ratio.GetHigh ();      // Get just the integer part, resulting in truncation
 
double ratioD = double (ratio);    // Convert to double, with loss of precision

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The exact ratio of the two operands.

Definition at line 1109 of file nstime.h.

◆ operator/ [3/4]

template<class T >

std::enable_if_t< std::is_integral_v< T >, Time > operator/	(	const Time &	lhs,
		T	rhs )

friend

Divide a Time by an integer value.

Template Parameters

T	Integer data type (int, long, etc.)

Parameters

[in]	lhs	The Time instance to scale
[in]	rhs	The scale value

Returns: A new Time instance containing the scaled value

Definition at line 1141 of file nstime.h.

◆ operator/ [4/4]

template<class T >

std::enable_if_t< std::is_floating_point_v< T >, Time > operator/	(	const Time &	lhs,
		T	rhs )

friend

Divide a Time by an integer value.

Template Parameters

T	Integer data type (int, long, etc.)

Parameters

[in]	lhs	The Time instance to scale
[in]	rhs	The scale value

Returns: A new Time instance containing the scaled value

Definition at line 1141 of file nstime.h.

◆ operator< [1/2]

bool operator<	(	const Time &	lhs,
		const Time &	rhs )

friend

Less than operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the first input value is less than the second input value.

Definition at line 947 of file nstime.h.

◆ operator< [2/2]

bool operator<	(	const Time &	time,
		const EventId &	event )

friend

Compare a Time to an EventId.

This is useful when you have cached a previously scheduled event:

m_event = Schedule (...);

and later you want to know the relationship between that event and some other Time when:

if (when < m_event) ...

Parameters

[in]	time	The Time operand.
[in]	event	The EventId

Returns: true if time is before (less than) the time stamp of the EventId.

Definition at line 982 of file nstime.h.

◆ operator<=

bool operator<=	(	const Time &	lhs,
		const Time &	rhs )

friend

Less than or equal operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the first input value is less than or equal to the second input value.

Definition at line 923 of file nstime.h.

◆ operator==

bool operator==	(	const Time &	lhs,
		const Time &	rhs )

friend

Equality operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the two input values are equal.

Definition at line 900 of file nstime.h.

◆ operator>

bool operator>	(	const Time &	lhs,
		const Time &	rhs )

friend

Greater than operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the first input value is greater than the second input value.

Definition at line 960 of file nstime.h.

◆ operator>=

bool operator>=	(	const Time &	lhs,
		const Time &	rhs )

friend

Greater than or equal operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: true if the first input value is greater than or equal to the second input value.

Definition at line 936 of file nstime.h.

◆ Rem

Time Rem	(	const Time &	lhs,
		const Time &	rhs )

friend

Addition operator for Time.

Parameters

[in]	lhs	The first value
[in]	rhs	The second value

Returns: The sum of the two input values.

Definition at line 1176 of file nstime.h.

◆ TimeStep()

Time TimeStep ( uint64_t ts )

Note: This is internal to the Time implementation.

Parameters

[in] ts The time value, in the current unit.

Returns: A Time.

Definition at line 1451 of file nstime.h.

Member Data Documentation

◆ g_markingTimes

Time::MarkedTimes * ns3::Time::g_markingTimes = nullptr

staticprivate

Record of outstanding Time objects which will need conversion when the resolution is set.

Internal:

Use a classic static variable so we can check in Time ctors without a function call.

We'd really like to initialize this here, but we don't want to require C++0x, so we init in time.cc. To ensure that happens before first use, we add a call to StaticInit (below) to every compilation unit which includes nstime.h.

Definition at line 749 of file nstime.h.

Referenced by Clear(), ClearMarkedTimes(), ConvertTimes(), Mark(), MarkingTimes(), and StaticInit().

◆ m_data

int64_t ns3::Time::m_data

private

Virtual time value, in the current unit.

Definition at line 868 of file nstime.h.

Referenced by Compare(), ConvertTimes(), and operator=().

The documentation for this class was generated from the following files:

src/core/model/nstime.h
src/core/model/time.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Related Symbols

Detailed Description

Member Typedef Documentation

◆ MarkedTimes

◆ TracedCallback

Member Enumeration Documentation

◆ Unit

Constructor & Destructor Documentation

◆ Time() [1/12]

◆ Time() [2/12]

◆ Time() [3/12]

◆ Time() [4/12]

◆ Time() [5/12]

◆ Time() [6/12]

◆ Time() [7/12]

◆ Time() [8/12]

◆ Time() [9/12]

◆ Time() [10/12]

◆ Time() [11/12]

◆ Time() [12/12]

◆ ~Time()

Member Function Documentation

◆ As()

◆ Clear()

◆ ClearMarkedTimes()

◆ Compare()

◆ ConvertTimes()

◆ From() [1/2]

◆ From() [2/2]

◆ FromDouble()

◆ FromInteger()

◆ GetDays()

◆ GetDouble()

◆ GetFemtoSeconds()

◆ GetHours()

◆ GetInteger()

◆ GetMicroSeconds()

◆ GetMilliSeconds()

◆ GetMinutes()

◆ GetNanoSeconds()

◆ GetPicoSeconds()

◆ GetResolution()

◆ GetSeconds()

◆ GetTimeStep()

◆ GetYears()

◆ IsNegative()

◆ IsPositive()

◆ IsStrictlyNegative()

◆ IsStrictlyPositive()

◆ IsZero()

◆ Mark()

◆ MarkingTimes()

◆ Max()

◆ Min()

◆ operator=()

◆ PeekInformation()

◆ PeekResolution()

◆ RoundTo()

◆ SetDefaultNsResolution()

◆ SetResolution() [1/2]

◆ SetResolution() [2/2]

◆ StaticInit()

◆ To()

◆ ToDouble()

◆ ToInteger()

Friends And Related Symbol Documentation

◆ Abs

◆ Div

◆ g_TimeStaticInit

◆ Max

◆ Min