ns3::TimeValue Class Reference

AttributeValue implementation for Time. More...

#include "nstime.h"

Inheritance diagram for ns3::TimeValue:

Collaboration diagram for ns3::TimeValue:

Public Member Functions
	TimeValue ()=default
	TimeValue (const Time &value)
	Constructor.
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
Time	Get () const
template<typename T>
bool	GetAccessor (T &value) const
	Access the Time value as type T.
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (const Time &value)
	Set the value.
Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()
virtual	~AttributeValue ()
Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
	SimpleRefCount ()
	Default constructor.
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.
uint32_t	GetReferenceCount () const
	Get the reference count of the object.
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.
void	Ref () const
	Increment the reference count.
void	Unref () const
	Decrement the reference count.

Private Attributes
Time	m_value
	The stored Time instance.

Detailed Description

AttributeValue implementation for Time.

See also

AttributeValue

Definition at line 1456 of file nstime.h.

Constructor & Destructor Documentation

TimeValue() [1/2]

ns3::TimeValue::TimeValue ( )

default

TimeValue() [2/2]

ns3::TimeValue::TimeValue

(

const Time &

value

)

Constructor.

Parameters

[in]

value

The Time value to use.

Definition at line 524 of file time.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::TimeValue::Copy ( ) const

overridevirtual

Returns

a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 524 of file time.cc.

DeserializeFromString()

bool ns3::TimeValue::DeserializeFromString ( std::string value, Ptr< const AttributeChecker > checker )

overridevirtual

Parameters

[in]	value	A string representation of the value
[in]	checker	A pointer to the checker associated to the attribute.

Returns

true if the input string was correctly-formatted and could be successfully deserialized, false otherwise.

Upon return of this function, this AttributeValue instance contains the deserialized value. In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implements ns3::AttributeValue.

Definition at line 524 of file time.cc.

Get()

Time ns3::TimeValue::Get

(

)

const

Returns

The Time value.

Definition at line 524 of file time.cc.

Referenced by ChannelAccessManagerTest< TxopType >::AddPhyDisconnectEvt(), ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::NullMessageSimulatorImpl::CalculateLookAhead(), RttEstimatorTestCase::DoRun(), TcpHyblaIncrementTest::DoRun(), ns3::StaWifiMac::GetBasicMultiLinkElement(), and ns3::MakeTimeChecker().

Here is the caller graph for this function:

GetAccessor()

template<typename T>

bool ns3::TimeValue::GetAccessor ( T & value ) const

inline

Access the Time value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The Time value, as type T.

Returns

true.

Definition at line 1456 of file nstime.h.

SerializeToString()

std::string ns3::TimeValue::SerializeToString ( Ptr< const AttributeChecker > checker ) const

overridevirtual

Parameters

[in]

checker

The checker associated to the attribute

Returns

A string representation of this value.

In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implements ns3::AttributeValue.

Definition at line 524 of file time.cc.

Set()

void ns3::TimeValue::Set

(

const Time &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 524 of file time.cc.

Member Data Documentation

m_value

Time ns3::TimeValue::m_value

private

The stored Time instance.

Definition at line 1456 of file nstime.h.

---

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

• src/core/model/nstime.h
• src/core/model/time.cc
• doc/introspected-doxygen.h