Trace classes with value semantics. More...

#include "traced-value.h"

Inheritance diagram for ns3::TracedValue< T >:

Collaboration diagram for ns3::TracedValue< T >:

Public Member Functions
	TracedValue ()
	Default constructor. More...

	TracedValue (const TracedValue &o)
	Copy constructor. More...

	TracedValue (const T &v)
	Construct from an explicit variable. More...

template<typename U >
	TracedValue (const TracedValue< U > &other)
	Copy from a TracedValue of a compatable type. More...

template<typename U >
	TracedValue (const U &other)
	Copy from a variable type compatible with this underlying type. More...

void	Connect (const CallbackBase &cb, std::string path)
	Connect a Callback with a context string. More...

void	ConnectWithoutContext (const CallbackBase &cb)
	Connect a Callback (without context.) More...

void	Disconnect (const CallbackBase &cb, std::string path)
	Disconnect a Callback which was connected with context. More...

void	DisconnectWithoutContext (const CallbackBase &cb)
	Disconnect a Callback which was connected without context. More...

T	Get (void) const
	Get the underlying value. More...

	operator T () const
	Cast to the underlying type. More...

TracedValue &	operator= (const TracedValue &o)
	Assignment. More...

void	Set (const T &v)
	Set the value of the underlying variable. More...


TracedValue &	operator++ ()
	Pre/post- increment/decrement operator. More...

TracedValue &	operator-- ()
	Pre/post- increment/decrement operator. More...

TracedValue	operator++ (int)
	Pre/post- increment/decrement operator. More...

TracedValue	operator-- (int)
	Pre/post- increment/decrement operator. More...

Private Attributes
TracedCallback< T, T >	m_cb
	The connected Callback. More...

T	m_v
	The underlying value. More...

Detailed Description

template<typename T>
class ns3::TracedValue< T >

Trace classes with value semantics.

If you want to trace the change of value of a class or primitive type which have value semantics (they must support operator !=), you can wrap them in an instance of this template. This instance will behave just like the original class (if it did not export any special method), and will define Connect/DisconnectWithoutContext methods to work with MakeTraceSourceAccessor.

Template Parameters

T	[explicit] The type of the underlying value being traced.

Definition at line 110 of file traced-value.h.

Constructor & Destructor Documentation

template<typename T>

ns3::TracedValue< T >::TracedValue ( )

inline

Default constructor.

Definition at line 114 of file traced-value.h.

template<typename T>

ns3::TracedValue< T >::TracedValue ( const TracedValue< T > & o )

inline

Copy constructor.

Parameters

[in] o The value to copy.

Definition at line 120 of file traced-value.h.

template<typename T>

ns3::TracedValue< T >::TracedValue ( const T & v )

inline

Construct from an explicit variable.

Parameters

[in] v The variable to trace.

Definition at line 126 of file traced-value.h.

template<typename T>

template<typename U >

ns3::TracedValue< T >::TracedValue ( const TracedValue< U > & other )

inline

Copy from a TracedValue of a compatable type.

Template Parameters

U	[deduced] The underlying type of the other TracedValue.

Parameters

[in] other The other TracedValuet to copy.

Definition at line 151 of file traced-value.h.

template<typename T>

template<typename U >

ns3::TracedValue< T >::TracedValue ( const U & other )

inline

Copy from a variable type compatible with this underlying type.

Template Parameters

U	[deduced] Type of the other variable.

Parameters

[in] other The other variable to copy.

Definition at line 160 of file traced-value.h.

Member Function Documentation

template<typename T>

void ns3::TracedValue< T >::Connect	(	const CallbackBase &	cb,
		std::string	path
	)

inline

Connect a Callback with a context string.

The context string will be provided as the first argument to the Callback function.

Parameters

[in]	cb	The Callback to connect to the target trace source.
[in]	path	The context to bind to the user callback.

Definition at line 180 of file traced-value.h.

template<typename T>

void ns3::TracedValue< T >::ConnectWithoutContext ( const CallbackBase & cb )

inline

Connect a Callback (without context.)

Parameters

[in] cb The callback to connect.

Definition at line 168 of file traced-value.h.

template<typename T>

void ns3::TracedValue< T >::Disconnect	(	const CallbackBase &	cb,
		std::string	path
	)

inline

Disconnect a Callback which was connected with context.

Parameters

[in]	cb	The Callback to disconnect.
[in]	path	The context to bind to the user callback.

Definition at line 197 of file traced-value.h.

template<typename T>

void ns3::TracedValue< T >::DisconnectWithoutContext ( const CallbackBase & cb )

inline

Disconnect a Callback which was connected without context.

Parameters

[in] cb The Callback to disconnect.

Definition at line 188 of file traced-value.h.

template<typename T>

T ns3::TracedValue< T >::Get ( void ) const

inline

Get the underlying value.

Returns: The value.

Definition at line 217 of file traced-value.h.

Referenced by ns3::TcpSocketBase::BytesInFlight(), ns3::TcpTxBuffer::CopyFromSequence(), ns3::TcpTxBuffer::DiscardUpTo(), ns3::TcpSocketBase::DoForwardUp(), ns3::GetCongStateFrom(), ns3::TcpSocketBase::NewAck(), ns3::operator!(), ns3::operator!=(), ns3::operator%(), ns3::operator%=(), ns3::operator&(), ns3::operator&=(), ns3::operator*(), ns3::operator*=(), ns3::operator+(), ns3::TracedValue< TcpCongState_t >::operator++(), ns3::operator+=(), ns3::operator-(), ns3::TracedValue< TcpCongState_t >::operator--(), ns3::operator-=(), ns3::operator/(), ns3::operator/=(), ns3::operator<<(), ns3::operator<<=(), ns3::operator==(), ns3::operator>(), ns3::operator>=(), ns3::operator>>(), ns3::operator>>=(), ns3::operator^(), ns3::operator^=(), ns3::operator|(), ns3::operator|=(), ns3::operator~(), ns3::TcpSocketBase::SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), ns3::TcpSocketBase::SendEmptyPacket(), ns3::TcpSocketBase::UnAckDataCount(), and ns3::TcpSocketBase::Window().

Here is the caller graph for this function:

template<typename T>

ns3::TracedValue< T >::operator T ( ) const

inline

Cast to the underlying type.

Returns: The underlying value.

Definition at line 132 of file traced-value.h.

template<typename T>

TracedValue& ns3::TracedValue< T >::operator++ ( )

inline

Pre/post- increment/decrement operator.

This invokes the Callback.

Returns: This TracedValue.

Definition at line 227 of file traced-value.h.

template<typename T>

TracedValue ns3::TracedValue< T >::operator++ ( int )

inline

Pre/post- increment/decrement operator.

This invokes the Callback.

Returns: This TracedValue.

Definition at line 241 of file traced-value.h.

template<typename T>

TracedValue& ns3::TracedValue< T >::operator-- ( )

inline

Pre/post- increment/decrement operator.

This invokes the Callback.

Returns: This TracedValue.

Definition at line 234 of file traced-value.h.

template<typename T>

TracedValue ns3::TracedValue< T >::operator-- ( int )

inline

Pre/post- increment/decrement operator.

This invokes the Callback.

Returns: This TracedValue.

Definition at line 249 of file traced-value.h.

template<typename T>

TracedValue& ns3::TracedValue< T >::operator= ( const TracedValue< T > & o )

inline

Assignment.

Parameters

[in] o The value to assign to this instance.

Returns: This TracedValue.

Definition at line 140 of file traced-value.h.

template<typename T>

void ns3::TracedValue< T >::Set ( const T & v )

inline

Set the value of the underlying variable.

If the new value differs from the old, the Callback will be invoked.

Parameters

[in] v The new value.

Definition at line 206 of file traced-value.h.

Referenced by ns3::operator%=(), ns3::operator&=(), ns3::operator*=(), ns3::TracedValue< TcpCongState_t >::operator++(), ns3::operator+=(), ns3::TracedValue< TcpCongState_t >::operator--(), ns3::operator-=(), ns3::operator/=(), ns3::operator<<=(), ns3::TracedValue< TcpCongState_t >::operator=(), ns3::operator>>=(), ns3::operator^=(), and ns3::operator|=().

Here is the caller graph for this function:

Member Data Documentation

template<typename T>

TracedCallback<T,T> ns3::TracedValue< T >::m_cb

private

The connected Callback.

Definition at line 263 of file traced-value.h.

Referenced by ns3::TracedValue< TcpCongState_t >::Connect(), ns3::TracedValue< TcpCongState_t >::ConnectWithoutContext(), ns3::TracedValue< TcpCongState_t >::Disconnect(), ns3::TracedValue< TcpCongState_t >::DisconnectWithoutContext(), and ns3::TracedValue< TcpCongState_t >::Set().

template<typename T>

T ns3::TracedValue< T >::m_v

private

The underlying value.

Definition at line 261 of file traced-value.h.

Referenced by ns3::TracedValue< TcpCongState_t >::Get(), ns3::TracedValue< ValueClassTest >::operator ValueClassTest(), ns3::TracedValue< TcpCongState_t >::operator=(), and ns3::TracedValue< TcpCongState_t >::Set().

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

src/core/model/traced-value.h

Public Member Functions

Private Attributes

Detailed Description

template<typename T> class ns3::TracedValue< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class ns3::TracedValue< T >