Hold a bool native type. More...

#include <boolean.h>

Inheritance diagram for ns3::BooleanValue:

Collaboration diagram for ns3::BooleanValue:

Public Member Functions
	BooleanValue ()

	BooleanValue (bool value)

virtual Ptr< AttributeValue >	Copy (void) const

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

bool	Get (void) const

template<typename T >
bool	GetAccessor (T &v) const

	operator bool () const

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

void	Set (bool 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...

SimpleRefCount &	operator= (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
bool	m_value

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

Detailed Description

Hold a bool native type.

This class can be used to hold bool variables which must go through the Attribute system.

Definition at line 38 of file boolean.h.

Constructor & Destructor Documentation

ns3::BooleanValue::BooleanValue ( )

Definition at line 28 of file boolean.cc.

References NS_LOG_FUNCTION.

ns3::BooleanValue::BooleanValue ( bool value )

Definition at line 33 of file boolean.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< AttributeValue > ns3::BooleanValue::Copy ( void ) const

virtual

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

Implements ns3::AttributeValue.

Definition at line 69 of file boolean.cc.

References NS_LOG_FUNCTION.

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

virtual

Parameters

value	a string representation of the value
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 90 of file boolean.cc.

References m_value, and NS_LOG_FUNCTION.

bool ns3::BooleanValue::Get ( void ) const

Definition at line 45 of file boolean.cc.

References m_value, and NS_LOG_FUNCTION.

Referenced by ns3::Node::ChecksumEnabled(), main(), and ns3::operator<<().

Here is the caller graph for this function:

template<typename T >

bool ns3::BooleanValue::GetAccessor ( T & v ) const

Definition at line 58 of file boolean.h.

References m_value.

ns3::BooleanValue::operator bool ( ) const

Definition at line 50 of file boolean.cc.

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

virtual

Parameters

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 76 of file boolean.cc.

References m_value, and NS_LOG_FUNCTION.

void ns3::BooleanValue::Set ( bool value )

Definition at line 39 of file boolean.cc.

References m_value, and NS_LOG_FUNCTION.