ns3::Time Class Reference

keep track of time unit. More...

#include <nstime.h>

Classes
struct	Information
struct	Resolution

Public Types
enum	Unit {   S = 0, MS = 1, US = 2, NS = 3,   PS = 4, FS = 5, LAST = 6 }

Public Member Functions
	Time ()
	Time (const Time &o)
	Time (double v)
	Time (int v)
	Time (long int v)
	Time (long long int v)
	Time (unsigned int v)
	Time (unsigned long int v)
	Time (unsigned long long int v)
	Time (const std::string &s)
	String constructor Construct Time object from common time expressions like " 1ms" or "10s". Supported units include:
	Time (const int64x64_t &value)
int	Compare (const Time &o) const
double	GetDouble (void) const
int64_t	GetFemtoSeconds (void) const
int64_t	GetInteger (void) const
int64_t	GetMicroSeconds (void) const
int64_t	GetMilliSeconds (void) const
int64_t	GetNanoSeconds (void) const
int64_t	GetPicoSeconds (void) const
double	GetSeconds (void) const
int64_t	GetTimeStep (void) const
bool	IsNegative (void) const
bool	IsPositive (void) const
bool	IsStrictlyNegative (void) const
bool	IsStrictlyPositive (void) const
bool	IsZero (void) const
	operator int64x64_t () const
Time &	operator= (const Time &o)
int64x64_t	To (enum Unit timeUnit) const
double	ToDouble (enum Unit timeUnit) const
int64_t	ToInteger (enum Unit timeUnit) const

Static Public Member Functions
static Time	From (const int64x64_t &from, enum Unit timeUnit)
static Time	From (const int64x64_t &value)
static Time	FromDouble (double value, enum Unit timeUnit)
static Time	FromInteger (uint64_t value, enum Unit timeUnit)
static enum Unit	GetResolution (void)
static void	SetResolution (enum Unit resolution)

Static Private Member Functions
static struct Resolution	GetNsResolution (void)
static struct Information *	PeekInformation (enum Unit timeUnit)
static struct Resolution *	PeekResolution (void)
static void	SetResolution (enum Unit unit, struct Resolution *resolution)

Private Attributes
int64_t	m_data

Friends
Time	Abs (const Time &time)
Time	Max (const Time &ta, const Time &tb)
Time	Min (const Time &ta, const Time &tb)
bool	operator!= (const Time &lhs, const Time &rhs)
Time	operator+ (const Time &lhs, const Time &rhs)
Time &	operator+= (Time &lhs, const Time &rhs)
Time	operator- (const Time &lhs, const Time &rhs)
Time &	operator-= (Time &lhs, const Time &rhs)
bool	operator< (const Time &lhs, const Time &rhs)
bool	operator<= (const Time &lhs, const Time &rhs)
bool	operator== (const Time &lhs, const Time &rhs)
bool	operator> (const Time &lhs, const Time &rhs)
bool	operator>= (const Time &lhs, const Time &rhs)

Detailed Description

keep track of time unit.

This template class is used to keep track of the value of a specific time unit: the type TimeUnit<1> is used to keep track of seconds, the type TimeUnit<2> is used to keep track of seconds squared, the type TimeUnit<-1> is used to keep track of 1/seconds, etc.

This base class defines all the functionality shared by all these time unit objects: it defines all the classic arithmetic operators +, -, *, /, and all the classic comparison operators: ==, !=, <, >, <=, >=. It is thus easy to add, substract, or multiply multiple TimeUnit objects. The return type of any such arithmetic expression is always a TimeUnit object.

The ns3::uint64_t, ns3::Time, ns3::TimeSquare, and ns3::TimeInvert classes are aliases for the TimeUnit<0>, TimeUnit<1>, TimeUnit<2> and TimeUnit<-1> types respectively.

For example:

Time<1> t1 = Seconds (10.0);
Time<1> t2 = Seconds (10.0);
Time<2> t3 = t1 * t2;
Time<0> t4 = t1 / t2;
Time<3> t5 = t3 * t1;
Time<-2> t6 = t1 / t5;
TimeSquare t7 = t3;
uint64_t s = t4;

If you try to assign the result of an expression which does not match the type of the variable it is assigned to, you will get a compiler error. For example, the following will not compile:

Time<1> = Seconds (10.0) * Seconds (1.5);

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

• ns3-Time-Abs ns3::Abs
• ns3-Time-Max ns3::Max
• ns3-Time-Min ns3::Min

keep track of time values and allow control of global simulation resolution

This class defines all the classic C++ arithmetic operators +, -, *, /, and all the classic comparison operators: ==, !=, <, >, <=, >=. It is thus easy to add, substract, or multiply multiple Time objects.

The ns3::uint64_t, ns3::TimeSquare, and ns3::TimeInvert classes are backward-compatibility aliases for ns3::Time.

For example:

Time t1 = Seconds (10.0);
Time t2 = Seconds (10.0);
Time t3 = t1 * t2;
Time t4 = t1 / t2;
Time t5 = t3 * t1;
Time t6 = t1 / t5;
Time t7 = t3;

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

• ns3-Time-Abs ns3::Abs
• ns3-Time-Max ns3::Max
• ns3-Time-Min ns3::Min

This class also controls the resolution of the underlying time value . The default resolution is nanoseconds. That is, TimeStep (1).GetNanoSeconds () will return

1. It is possible to either increase or decrease the resolution and the code tries really hard to make this easy.

If your resolution is X (say, nanoseconds) and if you create Time objects with a lower resolution (say, picoseconds), don't expect that this code will return 1: PicoSeconds (1).GetPicoSeconds (). It will most likely return 0 because the Time object has only 64 bits of fractional precision which means that PicoSeconds (1) is stored as a 64-bit aproximation of 1/1000 in the Time object. If you later multiply it again by the exact value 1000, the result is unlikely to be 1 exactly. It will be close to 1 but not exactly 1.

In general, it is thus a really bad idea to try to use time objects of a resolution higher than the global resolution controlled through Time::SetResolution. If you do need to use picoseconds, it's thus best to switch the global resolution to picoseconds to avoid nasty surprises.

Another important issue to keep in mind is that if you increase the global resolution, you also implicitely decrease the range of your simulation. i.e., the global simulation time is stored in a 64 bit integer whose interpretation will depend on the global resolution so, 2^64 picoseconds which is the maximum duration of your simulation if the global resolution is picoseconds is smaller than 2^64 nanoseconds which is the maximum duration of your simulation if the global resolution is nanoseconds.

Finally, don't even think about ever changing the global resolution after creating Time objects: all Time objects created before the call to SetResolution will contain values which are not updated to the new resolution. In practice, the default value for the attributes of many models is indeed calculated before the main function of the main program enters. Because of this, if you use one of these models (and it's likely), it's going to be hard to change the global simulation resolution in a way which gives reasonable results. This issue has been filed as bug 954 in the ns-3 bugzilla installation.

Definition at line 149 of file nstime.h.

Member Enumeration Documentation

enum ns3::Time::Unit

The unit to use to interpret a number representing time

Enumerator:

S
MS
US
NS
PS
FS
LAST

Definition at line 155 of file nstime.h.

Constructor & Destructor Documentation

ns3::Time::Time ( )

inline

Definition at line 171 of file nstime.h.

Referenced by From(), and FromInteger().

Here is the caller graph for this function:

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

inline

Definition at line 174 of file nstime.h.

ns3::Time::Time ( double  v )

inlineexplicit

Definition at line 177 of file nstime.h.

ns3::Time::Time ( int  v )

inlineexplicit

Definition at line 180 of file nstime.h.

ns3::Time::Time ( long int  v )

inlineexplicit

Definition at line 183 of file nstime.h.

ns3::Time::Time ( long long int  v )

inlineexplicit

Definition at line 186 of file nstime.h.

ns3::Time::Time ( unsigned int  v )

inlineexplicit

Definition at line 189 of file nstime.h.

ns3::Time::Time ( unsigned long int  v )

inlineexplicit

Definition at line 192 of file nstime.h.

ns3::Time::Time ( unsigned long long int  v )

inlineexplicit

Definition at line 195 of file nstime.h.

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

explicit

String constructor Construct Time object from common time expressions like " 1ms" or "10s". Supported units include:

• s (seconds)
• ms (milliseconds)
• us (microseconds)
• ns (nanoseconds)
• ps (picoseconds)
• fs (femtoseconds)

There can be no white space between the numerical portion and the units. Any otherwise malformed string causes a fatal error to occur.

Parameters

s	The string to parse into a Time

Definition at line 34 of file time.cc.

References FromDouble(), FS, MS, NS, NS_ABORT_MSG, PS, S, and US.

Here is the call graph for this function:

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

inlineexplicit

Definition at line 437 of file nstime.h.

Member Function Documentation

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

inline

Definition at line 253 of file nstime.h.

References m_data.

static Time ns3::Time::From ( const int64x64_t &  from, enum Unit  timeUnit  )

inlinestatic

Definition at line 403 of file nstime.h.

References ns3::Time::Information::fromMul, PeekInformation(), Time(), and ns3::Time::Information::timeFrom.

Referenced by ns3::FemtoSeconds(), FromDouble(), ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::NanoSeconds(), ns3::PicoSeconds(), and ns3::Seconds().

Here is the call graph for this function:

Here is the caller graph for this function:

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

inlinestatic

Definition at line 440 of file nstime.h.

References Time().

Here is the call graph for this function:

static Time ns3::Time::FromDouble ( double  value, enum Unit  timeUnit  )

inlinestatic

Parameters

value	to convert into a Time object
timeUnit	the unit of the value to convert

Returns

a new Time object

See Also

FromInteger, ToInteger, ToDouble

Definition at line 388 of file nstime.h.

References From().

Referenced by ns3::RttMeanDeviation::Measurement(), ns3::Seconds(), and Time().

Here is the call graph for this function:

Here is the caller graph for this function:

static Time ns3::Time::FromInteger ( uint64_t  value, enum Unit  timeUnit  )

inlinestatic

Parameters

value	to convert into a Time object
timeUnit	the unit of the value to convert

Returns

a new Time object

This method interprets the input value according to the input unit and constructs a matching Time object.

See Also

FromDouble, ToDouble, ToInteger

Definition at line 347 of file nstime.h.

References ns3::Time::Information::factor, ns3::Time::Information::fromMul, PeekInformation(), and Time().

Referenced by ns3::FemtoSeconds(), ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::NanoSeconds(), ns3::PicoSeconds(), and ns3::RttMeanDeviation::RetransmitTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::Time::GetDouble ( void  ) const

inline

Definition at line 315 of file nstime.h.

References m_data.

int64_t ns3::Time::GetFemtoSeconds ( void  ) const

inline

Returns

an approximation in femtoseconds of the time stored in this instance.

Definition at line 303 of file nstime.h.

References FS, and ToInteger().

Here is the call graph for this function:

int64_t ns3::Time::GetInteger ( void  ) const

inline

Definition at line 319 of file nstime.h.

References GetTimeStep().

Here is the call graph for this function:

int64_t ns3::Time::GetMicroSeconds ( void  ) const

inline

Returns

an approximation in microseconds of the time stored in this instance.

Definition at line 279 of file nstime.h.

References ToInteger(), and US.

Referenced by ns3::dot11s::IeBeaconTiming::BeaconIntervalToU16(), ns3::WifiRemoteStationInfo::CalculateAveragingCoefficient(), ns3::TxDurationTest::CheckTxDuration(), ns3::dot11s::HwmpProtocol::GetActivePathLifetime(), ns3::NscTcpL4Protocol::gettime(), Ns3TcpStateTestCase::Ipv4L3Tx(), Ns3TcpLossTestCase::Ipv4L3Tx(), Ns3TcpInteroperabilityTestCase::Ipv4L3Tx(), ns3::MeshWifiInterfaceMac::Receive(), ns3::dot11s::HwmpProtocol::ReceivePreq(), ns3::MeshWifiInterfaceMac::SendBeacon(), ns3::ApWifiMac::SendOneBeacon(), ns3::dot11s::HwmpProtocol::SendProactivePreq(), ns3::ApWifiMac::SendProbeResp(), ns3::dot11s::PeerLink::SetBeaconInformation(), ns3::ApWifiMac::SetBeaconInterval(), ns3::dot11s::PeerLink::SetConfirmTimer(), ns3::WifiMacHeader::SetDuration(), ns3::dot11s::PeerLink::SetHoldingTimer(), ns3::dot11s::PeerLink::SetRetryTimer(), ns3::DcfManager::SetSlot(), ns3::dot11s::IeBeaconTiming::TimestampToU16(), ns3::dot11s::PeerManagementProtocol::TimeToTu(), ns3::MinstrelWifiManager::UpdateStats(), and ns3::PcapFileWrapper::Write().

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t ns3::Time::GetMilliSeconds ( void  ) const

inline

Returns

an approximation in milliseconds of the time stored in this instance.

Definition at line 271 of file nstime.h.

References MS, and ToInteger().

Referenced by ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), ns3::LteRlcAm::DoReceivePdu(), ns3::LteRlcUm::DoReportBufferStatus(), ns3::LteRlcAm::DoTransmitPdcpPdu(), ns3::TraceFadingLossModel::LoadTrace(), JakesPropagationExample::Next(), ns3::V4Ping::Receive(), ns3::aodv::RrepHeader::RrepHeader(), ns3::aodv::RrepHeader::SetHello(), ns3::aodv::RrepHeader::SetLifeTime(), ns3::UplinkSchedulerSimple::SetupServiceFlow(), ns3::UplinkSchedulerMBQoS::SetupServiceFlow(), and ns3::UplinkSchedulerRtps::SetupServiceFlow().

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t ns3::Time::GetNanoSeconds ( void  ) const

inline

Returns

an approximation in nanoseconds of the time stored in this instance.

Definition at line 287 of file nstime.h.

References NS, and ToInteger().

Referenced by ns3::AcousticModemEnergyModel::ChangeState(), ns3::WifiRadioEnergyModel::ChangeState(), ns3::MacStatsCalculator::DlScheduling(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LtePdcp::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), ns3::TimeSimpleTestCase::DoRun(), ns3::SimulatorEventsTestCase::NowUs(), ns3::MpiInterface::SendPacket(), ns3::RlcTag::Serialize(), ns3::PdcpTag::Serialize(), ns3::Synchronizer::TimeStepToNanosecond(), ns3::MacStatsCalculator::UlScheduling(), ns3::RadioBearerStatsCalculator::WriteDlResults(), and ns3::RadioBearerStatsCalculator::WriteUlResults().

Here is the call graph for this function:

Here is the caller graph for this function:

struct Time::Resolution ns3::Time::GetNsResolution ( void  )

staticreadprivate

Definition at line 86 of file time.cc.

References NS, and SetResolution().

Referenced by PeekResolution().

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t ns3::Time::GetPicoSeconds ( void  ) const

inline

Returns

an approximation in picoseconds of the time stored in this instance.

Definition at line 295 of file nstime.h.

References PS, and ToInteger().

Here is the call graph for this function:

enum Time::Unit ns3::Time::GetResolution ( void  )

static

Returns

the current global resolution.

Definition at line 133 of file time.cc.

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

Referenced by ns3::TimeSimpleTestCase::DoSetup(), and ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::Time::GetSeconds ( void  ) const

inline

Returns

an approximation in seconds of the time stored in this instance.

Definition at line 262 of file nstime.h.

References S, and ToDouble().

Referenced by ns3::dsr::RouteCache::AddRoute_Link(), ns3::AsciiPhyReceiveSinkWithContext(), ns3::AsciiPhyReceiveSinkWithoutContext(), ns3::AsciiPhyRxOkEvent(), ns3::AsciiPhyTransmitSinkWithContext(), ns3::AsciiPhyTransmitSinkWithoutContext(), ns3::AsciiPhyTxEvent(), ns3::WimaxHelper::AsciiRxEvent(), ns3::WimaxHelper::AsciiTxEvent(), ns3::UanPhyCalcSinrFhFsk::CalcSinrDb(), ns3::InterferenceHelper::CalculateChunkSuccessRate(), ns3::SimpleOfdmWimaxPhy::CalculateDataRate(), ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::BasicEnergySource::CalculateRemainingEnergy(), ns3::LiIonEnergySource::CalculateRemainingEnergy(), Bench::Cb(), ns3::AcousticModemEnergyModel::ChangeState(), ns3::WifiRadioEnergyModel::ChangeState(), ns3::UplinkSchedulerMBQoS::CheckDeadline(), CheckQueueSize(), ns3::UanMacRcGw::ComputeAlpha(), ns3::UanMacRcGw::ComputeExpS(), BatteryLifetimeTest::ConstantLoadTest(), ns3::Ns2MobilityHelperTest::CourseChange(), ns3::WaypointMobilityModelNotifyTest::CourseChangeCallback(), ns3::AnimationInterface::CsmaPhyTxEndTrace(), Ns3TcpLossTestCase::CwndTracer(), ns3::AsciiTraceHelper::DefaultDequeueSinkWithContext(), ns3::AsciiTraceHelper::DefaultDequeueSinkWithoutContext(), ns3::AsciiTraceHelper::DefaultDropSinkWithContext(), ns3::AsciiTraceHelper::DefaultDropSinkWithoutContext(), ns3::AsciiTraceHelper::DefaultEnqueueSinkWithContext(), ns3::AsciiTraceHelper::DefaultEnqueueSinkWithoutContext(), ns3::AsciiTraceHelper::DefaultReceiveSinkWithContext(), ns3::AsciiTraceHelper::DefaultReceiveSinkWithoutContext(), ns3::AnimationInterface::DevTxTrace(), ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), ns3::SimpleOfdmWimaxPhy::DoGetFrameDurationCode(), ns3::SimpleOfdmWimaxPhy::DoGetNrBytes(), ns3::SimpleOfdmWimaxPhy::DoGetNrSymbols(), ns3::TimesWithSignsTestCase::DoRun(), ns3::SimpleOfdmWimaxPhy::DoSetPhyParameters(), ns3::dot11s::HwmpProtocol::DoStart(), ns3::MeshWifiInterfaceMac::DoStart(), ns3::RandomWalk2dMobilityModel::DoWalk(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::LteTestSinrChunkProcessor::End(), ns3::LteCqiSinrChunkProcessor::End(), ns3::LtePemSinrChunkProcessor::End(), ns3::BaseStationNetDevice::EndDlSubFrame(), ns3::BaseStationNetDevice::EndUlSubFrame(), ns3::UanMacCw::Enqueue(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::LteTestSinrChunkProcessor::EvaluateSinrChunk(), ns3::LteCqiSinrChunkProcessor::EvaluateSinrChunk(), ns3::LtePemSinrChunkProcessor::EvaluateSinrChunk(), ExampleFunction(), ns3::dsr::RouteCache::FindSameRoute(), ns3::SpectrumAnalyzer::GenerateReport(), GenerateTraffic(), ns3::UanMacRcGw::GetExpPdk(), ns3::dsdv::RoutingProtocol::GetSettlingTime(), ns3::JakesProcess::Oscillator::GetValueAt(), ns3::AnimationInterface::GetXMLOpenClose_linkupdate(), ns3::AnimationInterface::GetXMLOpenClose_nodeupdate(), MyModel::HandleEvent(), DynamicGlobalRoutingTestCase::HandleRead(), ns3::dsr::RouteCache::IncStability(), ns3::RedQueue::InitializeParams(), ns3::SubscriberStationNetDevice::InitSubscriberStationNetDevice(), ns3::aodv::RoutingTableEntry::Invalidate(), ns3::Ipv4L3ProtocolDropSinkWithContext(), ns3::Ipv4L3ProtocolDropSinkWithoutContext(), ns3::Ipv4L3ProtocolRxSinkWithContext(), ns3::Ipv4L3ProtocolRxSinkWithoutContext(), ns3::Ipv4L3ProtocolTxSinkWithContext(), ns3::Ipv4L3ProtocolTxSinkWithoutContext(), ns3::Ipv6L3ProtocolDropSinkWithContext(), ns3::Ipv6L3ProtocolDropSinkWithoutContext(), ns3::Ipv6L3ProtocolRxSinkWithContext(), ns3::Ipv6L3ProtocolRxSinkWithoutContext(), ns3::Ipv6L3ProtocolTxSinkWithContext(), ns3::Ipv6L3ProtocolTxSinkWithoutContext(), ns3::ArpCache::Entry::IsExpired(), ns3::olsr::RoutingProtocol::LinkSensing(), main(), ns3::aodv::RoutingTable::MarkLinkAsUnidirectional(), ns3::BaseStationNetDevice::MarkUplinkAllocations(), modify(), ns3::UanMacCw::NotifyTxStart(), ns3::operator*(), ns3::operator<<(), ns3::SSLinkManager::PerformBackoff(), ns3::SeqTsHeader::Print(), ns3::UanHeaderRcData::Print(), ns3::UanHeaderRcRts::Print(), ns3::dsdv::RoutingTableEntry::Print(), ns3::UanHeaderRcCtsGlobal::Print(), ns3::UanHeaderRcCts::Print(), PrintCellInfo(), ns3::dsdv::RoutingProtocol::PrintRoutingTable(), ns3::aodv::RoutingProtocol::PrintRoutingTable(), ns3::Ipv4ListRouting::PrintRoutingTable(), ns3::Ipv6ListRouting::PrintRoutingTable(), ns3::Ipv6StaticRouting::PrintRoutingTable(), ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest(), ns3::BSLinkManager::ProcessRangingRequest(), ns3::AnimPacketInfo::ProcessRxEnd(), ns3::SubscriberStationNetDevice::ProcessUlMap(), ns3::AnimationInterface::PurgePendingCsma(), ns3::AnimationInterface::PurgePendingLte(), ns3::AnimationInterface::PurgePendingWifi(), ns3::AnimationInterface::PurgePendingWimax(), RandomFunction(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::dsdv::RoutingProtocol::RecvDsdv(), ns3::dot11s::HwmpProtocol::Report(), ns3::flame::FlameProtocol::Report(), ns3::dot11s::PeerLink::Report(), ns3::MeshWifiInterfaceMac::Report(), ns3::MeshHelper::Report(), ns3::FlowMonitor::ReportLastRx(), NetAnimExperiment::ResetData(), Experiment::ResetData(), ns3::RttMeanDeviation::RetransmitTimeout(), ns3::RttEstimator::RttEstimator(), ns3::RvBatteryModel::RvModelAFunction(), ns3::UanMacRc::ScheduleData(), ns3::dsr::DsrRouting::ScheduleRreqRetry(), ns3::aodv::RoutingProtocol::SendRerrMessage(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::UanHeaderRcData::Serialize(), ns3::UanHeaderRcRts::Serialize(), ns3::UanHeaderRcCtsGlobal::Serialize(), ns3::UanHeaderRcCts::Serialize(), ns3::dot11s::PeerLink::SetBeaconInformation(), ns3::SimpleDeviceEnergyModel::SetCurrentA(), ns3::olsr::MessageHeader::Hello::SetHTime(), ns3::UanPdp::SetTap(), ns3::olsr::MessageHeader::SetVTime(), DynamicGlobalRoutingTestCase::SinkRx(), SocketPrinter(), ns3::dsr::DsrRouting::Start(), ns3::UanMacRcGw::StartCycle(), ns3::BaseStationNetDevice::StartDlSubFrame(), Ns3TcpStateTestCase::StartFlow(), Ns3TcpLossTestCase::StartFlow(), ns3::BaseStationNetDevice::StartFrame(), ns3::UanMacCw::StartTimer(), ns3::BaseStationNetDevice::StartUlSubFrame(), ns3::UanPdp::SumTapsC(), ns3::UanPdp::SumTapsFromMaxC(), ns3::UanPdp::SumTapsFromMaxNc(), ns3::UanPdp::SumTapsNc(), TestDeterministicByTime(), ns3::TimePrinter(), ns3::CsmaNetDevice::TransmitCompleteEvent(), ns3::CsmaChannel::TransmitEnd(), ns3::PointToPointNetDevice::TransmitStart(), ns3::CsmaNetDevice::TransmitStart(), ns3::ConstantVelocityHelper::Update(), BatteryLifetimeTest::VariableLoadTest(), ns3::WriteAveragePowerSpectralDensityReport(), ns3::AnimationInterface::WriteDummyPacket(), Ns3TcpStateTestCase::WriteUntilBufferFull(), and Ns3TcpLossTestCase::WriteUntilBufferFull().

Here is the call graph for this function:

int64_t ns3::Time::GetTimeStep ( void  ) const

inline

Returns

an approximation of the time stored in this instance in the units specified in m_tsPrecision.

Definition at line 311 of file nstime.h.

References m_data.

Referenced by GetInteger(), ns3::Radvd::HandleRead(), ns3::Synchronizer::NanosecondToTimeStep(), ns3::OmnetDataOutput::OmnetOutputCallback::OutputSingleton(), ns3::SqliteDataOutput::SqliteOutputCallback::OutputSingleton(), ns3::RealtimeSimulatorImpl::ProcessOneEvent(), ns3::DefaultSimulatorImpl::Schedule(), ns3::RealtimeSimulatorImpl::Schedule(), ns3::DistributedSimulatorImpl::Schedule(), ns3::RealtimeSimulatorImpl::ScheduleRealtimeWithContext(), ns3::DefaultSimulatorImpl::ScheduleWithContext(), ns3::RealtimeSimulatorImpl::ScheduleWithContext(), and ns3::DistributedSimulatorImpl::ScheduleWithContext().

Here is the caller graph for this function:

bool ns3::Time::IsNegative ( void  ) const

inline

Returns

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

Definition at line 227 of file nstime.h.

References m_data.

bool ns3::Time::IsPositive ( void  ) const

inline

Returns

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

Definition at line 234 of file nstime.h.

References m_data.

Referenced by ns3::DefaultSimulatorImpl::Schedule(), ns3::RealtimeSimulatorImpl::Schedule(), and ns3::DistributedSimulatorImpl::Schedule().

Here is the caller graph for this function:

bool ns3::Time::IsStrictlyNegative ( void  ) const

inline

Returns

true if the time is strictly negative, false otherwise.

Definition at line 241 of file nstime.h.

References m_data.

bool ns3::Time::IsStrictlyPositive ( void  ) const

inline

Returns

true if the time is strictly positive, false otherwise.

Definition at line 248 of file nstime.h.

References m_data.

bool ns3::Time::IsZero ( void  ) const

inline

Returns

true if the time is zero, false otherwise.

Definition at line 220 of file nstime.h.

References m_data.

Referenced by main(), and ns3::YansWifiPhy::StartReceivePacket().

Here is the caller graph for this function:

ns3::Time::operator int64x64_t ( ) const

inline

Definition at line 433 of file nstime.h.

References m_data.

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

inline

Definition at line 166 of file nstime.h.

References m_data.

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

inlinestaticreadprivate

Definition at line 465 of file nstime.h.

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

Referenced by From(), FromInteger(), To(), and ToInteger().

Here is the call graph for this function:

Here is the caller graph for this function:

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

inlinestaticreadprivate

Definition at line 460 of file nstime.h.

References GetNsResolution().

Referenced by GetResolution(), PeekInformation(), and SetResolution().

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

Parameters

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 93 of file time.cc.

References PeekResolution().

Referenced by ns3::TimeSimpleTestCase::DoRun(), ns3::TimeSimpleTestCase::DoTeardown(), and GetNsResolution().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Time::SetResolution ( enum Unit  unit, struct Resolution *  resolution  )

staticprivate

Definition at line 98 of file time.cc.

References ns3::Time::Information::factor, ns3::Time::Information::fromMul, ns3::Time::Resolution::info, LAST, NS_ASSERT, ns3::Time::Information::timeFrom, ns3::Time::Information::timeTo, ns3::Time::Information::toMul, and ns3::Time::Resolution::unit.

int64x64_t ns3::Time::To ( enum Unit  timeUnit ) const

inline

Definition at line 419 of file nstime.h.

References m_data, PeekInformation(), ns3::Time::Information::timeTo, and ns3::Time::Information::toMul.

Referenced by ns3::OnOffApplication::CancelEvents(), and ToDouble().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::Time::ToDouble ( enum Unit  timeUnit ) const

inline

Parameters

timeUnit

the unit of the value to return

Returns

double time value

Convert the input time into a floating point value according to the requested time unit.

Definition at line 399 of file nstime.h.

References To().

Referenced by GetSeconds(), and ns3::RttMeanDeviation::Measurement().

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t ns3::Time::ToInteger ( enum Unit  timeUnit ) const

inline

Parameters

timeUnit

the unit of the value to return

Returns

int64_t time value

Convert the input time into an integer value according to the requested time unit.

Definition at line 367 of file nstime.h.

References ns3::Time::Information::factor, m_data, PeekInformation(), and ns3::Time::Information::toMul.

Referenced by GetFemtoSeconds(), GetMicroSeconds(), GetMilliSeconds(), GetNanoSeconds(), GetPicoSeconds(), and ns3::RttMeanDeviation::RetransmitTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

Time Abs ( const Time &  time )

friend

Time Max ( const Time &  ta, const Time &  tb  )

friend

Time Min ( const Time &  ta, const Time &  tb  )

friend

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

friend

Definition at line 496 of file nstime.h.

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

friend

Definition at line 520 of file nstime.h.

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

friend

Definition at line 528 of file nstime.h.

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

friend

Definition at line 524 of file nstime.h.

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

friend

Definition at line 533 of file nstime.h.

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

friend

Definition at line 511 of file nstime.h.

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

friend

Definition at line 501 of file nstime.h.

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

friend

Definition at line 491 of file nstime.h.

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

friend

Definition at line 516 of file nstime.h.

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

friend

Definition at line 506 of file nstime.h.

Member Data Documentation

int64_t ns3::Time::m_data

private

Definition at line 487 of file nstime.h.

Referenced by Compare(), GetDouble(), GetTimeStep(), IsNegative(), IsPositive(), IsStrictlyNegative(), IsStrictlyPositive(), IsZero(), operator int64x64_t(), ns3::operator!=(), ns3::operator+(), ns3::operator+=(), ns3::operator-(), ns3::operator-=(), ns3::operator<(), ns3::operator<=(), operator=(), ns3::operator==(), ns3::operator>(), ns3::operator>=(), To(), and ToInteger().

---

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

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