ns3::AttributeAccessor Class Reference [Attribute]

allow setting and getting the value of an attribute. More...

#include <attribute.h>

Inheritance diagram for ns3::AttributeAccessor:

Collaboration diagram for ns3::AttributeAccessor:

List of all members.

Public Member Functions
virtual bool	Set (ObjectBase *object, const AttributeValue &value) const =0
virtual bool	Get (const ObjectBase *object, AttributeValue &attribute) const =0
virtual bool	HasGetter (void) const =0
virtual bool	HasSetter (void) const =0

---

Detailed Description

allow setting and getting the value of an attribute.

The goal of this class is to hide from the user how an attribute is actually set or get to or from a class instance. Implementations of this base class are usually provided through the MakeAccessorHelper template functions, hidden behind an ATTRIBUTE_HELPER_* macro.

---

Member Function Documentation

virtual bool ns3::AttributeAccessor::Get	(	const ObjectBase *	object,
		AttributeValue &	attribute
	)			const [pure virtual]

Parameters:

	object	the object instance to get the value from
	attribute	a pointer to where the value should be set.

Returns:

true if the value could be read successfully, and stored in the input value, false otherwise.

This method expects that the caller has checked that the input value is valid with AttributeChecker::Check.

virtual bool ns3::AttributeAccessor::HasGetter

(

void

)

const [pure virtual]

Returns:

true if this accessor supports the Get operation, false otherwise.

virtual bool ns3::AttributeAccessor::HasSetter

(

void

)

const [pure virtual]

Returns:

true if this accessor supports the Set operation, false otherwise.

virtual bool ns3::AttributeAccessor::Set	(	ObjectBase *	object,
		const AttributeValue &	value
	)			const [pure virtual]

Parameters:

	object	the object instance to set the value in
	value	the value to set

Returns:

true if the value could be set successfully, false otherwise.

This method expects that the caller has checked that the input value is valid with AttributeChecker::Check.

---

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

• src/core/attribute.h