Management of virtual time in real world units. More...

Collaboration diagram for Virtual Time:

Modules
	Standard Time Units.
	Convenience constructors in standard units.

Files
file	nstime.h
	Declaration of classes ns3::Time and ns3::TimeWithUnit, and the TimeValue implementation classes.

file	time.cc
	Implementation of classes ns3::Time and ns3::TimeWithUnit, and the TimeValue implementation classes.

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

struct	ns3::Time::Resolution
	Current time unit, and conversion info. More...

class	ns3::Time
	Simulation virtual time values and global simulation resolution. More...

class	ns3::TimeWithUnit
	A Time with attached unit, to facilitate output in that unit. More...

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

Functions
Ptr< const AttributeChecker >	ns3::MakeTimeChecker (const Time min, const Time max)
	Helper to make a Time checker with bounded range. More...

Ptr< const AttributeChecker >	ns3::MakeTimeChecker (void)
	Helper to make an unbounded Time checker. More...

Ptr< const AttributeChecker >	ns3::MakeTimeChecker (const Time min)
	Helper to make a Time checker with a lower bound. More...

std::ostream &	ns3::operator<< (std::ostream &os, const Time &time)
	Time output streamer. More...

std::istream &	ns3::operator>> (std::istream &is, Time &time)
	Time input streamer. More...

Time	ns3::TimeStep (uint64_t ts)

Detailed Description

Management of virtual time in real world units.

The underlying simulator is unit agnostic, just dealing with dimensionless virtual time. Models usually need to handle time in real world units, such as seconds, and conversions/scaling between different units, between minutes and seconds, for example.

The convenience constructors in the Standard Units module make it easy to create Times in specific units.

The Time::SetResolution() function allows a one-time change of the base resolution, before Simulator::Run().

Enumeration Type Documentation

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

Definition at line 108 of file nstime.h.

Function Documentation

Ptr< const AttributeChecker > ns3::MakeTimeChecker	(	const Time	min,
		const Time	max
	)

Helper to make a Time checker with bounded range.

Both limits are inclusive

Parameters

[in]	min	Minimum allowed value.
[in]	max	Maximum allowed value.

Returns: The AttributeChecker

Definition at line 446 of file time.cc.

References ns3::Copy(), ns3::Create(), ns3::TimeValue::Get(), NS_LOG_FUNCTION, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

ns3::Ptr< const ns3::AttributeChecker > ns3::MakeTimeChecker ( void )

inline

Helper to make an unbounded Time checker.

Returns: The AttributeChecker; The AttributeChecker.

See also: AttributeChecker

Definition at line 978 of file nstime.h.

References ns3::MakeTimeChecker(), ns3::Time::Max(), and ns3::Time::Min().

Here is the call graph for this function:

Ptr<const AttributeChecker> ns3::MakeTimeChecker ( const Time min )

inline

Helper to make a Time checker with a lower bound.

Parameters

[in] min Minimum allowed value.

Returns: The AttributeChecker

Definition at line 991 of file nstime.h.

References ns3::MakeTimeChecker(), and ns3::Time::Max().

Here is the call graph for this function:

std::ostream & ns3::operator<<	(	std::ostream &	os,
		const Time &	time
	)

Time output streamer.

Generates output such as "3.96ns". Times are printed with the following format flags (independent of the stream flags):

showpos
fixed
left The stream width and precision are ignored; Time output always includes ".0".

Parameters

[in,out]	os	The output stream.
[in]	time	The Time to put on the stream.

Returns: The stream.

Definition at line 395 of file time.cc.

References ns3::Time::As(), and ns3::Time::GetResolution().

Here is the call graph for this function:

std::istream & ns3::operator>>	(	std::istream &	is,
		Time &	time
	)

Time input streamer.

Uses the Time::Time (const std::string &) constructor

Parameters

[in,out]	is	The input stream.
[out]	time	The Time variable to set from the stream data.

Returns: The stream.

Definition at line 435 of file time.cc.

Time ns3::TimeStep ( uint64_t ts )

inline

Internal: Scheduler interface

Parameters

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

Returns: A Time.

Definition at line 952 of file nstime.h.

Referenced by ns3::BuildingListPriv::Add(), ns3::NodeListPriv::Add(), ns3::TcpSocketBase::DoForwardUp(), ns3::Application::DoInitialize(), TimeSimpleTestCase::DoRun(), ns3::NullMessageSimulatorImpl::GetDelayLeft(), ns3::DefaultSimulatorImpl::GetDelayLeft(), ns3::RealtimeSimulatorImpl::GetDelayLeft(), ns3::DistributedSimulatorImpl::GetDelayLeft(), ns3::Timer::GetDelayLeft(), ns3::NullMessageSimulatorImpl::GetMaximumSimulationTime(), ns3::DefaultSimulatorImpl::GetMaximumSimulationTime(), ns3::RealtimeSimulatorImpl::GetMaximumSimulationTime(), ns3::DistributedSimulatorImpl::GetMaximumSimulationTime(), ns3::SeqTsHeader::GetTs(), ns3::DelayJitterEstimationTimestampTag::GetTxTime(), ns3::CoDelTimestampTag::GetTxTime(), ns3::Application::GetTypeId(), ns3::NullMessageSimulatorImpl::Next(), ns3::DistributedSimulatorImpl::Next(), ns3::NullMessageSimulatorImpl::Now(), ns3::DefaultSimulatorImpl::Now(), ns3::RealtimeSimulatorImpl::Now(), ns3::DistributedSimulatorImpl::Now(), ns3::SeqTsHeader::Print(), ns3::RealtimeSimulatorImpl::RealtimeNow(), ChannelAccessTestCase::Receive(), AnnexC_TestCase::Receive(), ns3::TcpSocketBase::ReceivedAck(), ns3::NullMessageSimulatorImpl::Schedule(), ns3::DefaultSimulatorImpl::Schedule(), ns3::RealtimeSimulatorImpl::Schedule(), ns3::DistributedSimulatorImpl::Schedule(), ns3::NullMessageSimulatorImpl::ScheduleWithContext(), ns3::DefaultSimulatorImpl::ScheduleWithContext(), ns3::TcpSocketBase::Send(), and ns3::Synchronizer::TimeStepToNanosecond().

Here is the caller graph for this function:

Modules

Files

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation