A Discrete-Event Network Simulator
API
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 ()
 
 TimeValue (const Time &value)
 Copy constructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
Time Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Time value as type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const Time &value)
 Set the value. More...
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
virtual Ptr< AttributeValueCopy (void) const =0
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)=0
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const =0
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Time m_value
 The stored Time instance. More...
 

Detailed Description

AttributeValue implementation for Time.

See also
AttributeValue

Definition at line 1308 of file nstime.h.

Constructor & Destructor Documentation

◆ TimeValue() [1/2]

ns3::TimeValue::TimeValue ( )

Definition at line 519 of file time.cc.

◆ TimeValue() [2/2]

Time ns3::TimeValue::TimeValue ( const Time value)

Copy constructor.

Parameters
[in]valueThe Time value to copy.

Definition at line 519 of file time.cc.

Member Function Documentation

◆ Copy()

Ptr< AttributeValue > ns3::TimeValue::Copy ( void  ) const
virtual
Returns
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 519 of file time.cc.

◆ DeserializeFromString()

bool ns3::TimeValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
[in]valueA string representation of the value
[in]checkerA 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 519 of file time.cc.

◆ Get()

◆ 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]valueThe Time value, as type T.
Returns
true.

Definition at line 1308 of file nstime.h.

◆ SerializeToString()

std::string ns3::TimeValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
[in]checkerThe 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 519 of file time.cc.

◆ Set()

void ns3::TimeValue::Set ( const Time value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 519 of file time.cc.

Member Data Documentation

◆ m_value

Time ns3::TimeValue::m_value
private

The stored Time instance.

Definition at line 1308 of file nstime.h.


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