A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::TimeValue Class Reference

hold objects of type ns3::Time More...

#include <nstime.h>

+ Inheritance diagram for ns3::TimeValue:
+ Collaboration diagram for ns3::TimeValue:

Public Member Functions

 TimeValue ()
 
 TimeValue (const Time &value)
 
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
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const Time &value)
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 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. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Time m_value
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

hold objects of type ns3::Time

Definition at line 961 of file nstime.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Implements ns3::AttributeValue.

virtual bool ns3::TimeValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
valuea string representation of the value
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.

Time ns3::TimeValue::Get ( void  ) const
template<typename T >
bool ns3::TimeValue::GetAccessor ( T &  value) const
inline

Definition at line 961 of file nstime.h.

virtual std::string ns3::TimeValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
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.

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

Member Data Documentation

Time ns3::TimeValue::m_value
private

Definition at line 961 of file nstime.h.


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