A Discrete-Event Network Simulator
API
Vector3D Attribute

Attribute implementation for Vector3D. More...

+ Collaboration diagram for Vector3D Attribute:

Classes

class  ns3::Vector3DChecker
 AttributeChecker implementation for Vector3DValue. More...
 
class  ns3::Vector3DValue
 AttributeValue implementation for Vector3D. More...
 

Typedefs

typedef Vector3DChecker ns3::VectorChecker
 Vector alias typedef for compatibility with mobility models. More...
 
typedef Vector3DValue ns3::VectorValue
 Vector alias typedef for compatibility with mobility models. More...
 

Functions

template<typename T1 >
Ptr< const AttributeAccessor > ns3::MakeVector3DAccessor (T1 a1)
 Create an AttributeAccessor for a class data member, or a lone class get functor or set method. More...
 
template<typename T1 , typename T2 >
Ptr< const AttributeAccessor > ns3::MakeVector3DAccessor (T1 a1, T2 a2)
 Create an AttributeAccessor using a pair of get functor and set methods from a class. More...
 
Ptr< const AttributeChecker > ns3::MakeVector3DChecker (void)
 
template<typename T1 >
Ptr< const AttributeAccessor > ns3::MakeVectorAccessor (T1 a1)
 Create an AttributeAccessor for a class data member, or a lone class get functor or set method. More...
 
template<typename T1 , typename T2 >
Ptr< const AttributeAccessor > ns3::MakeVectorAccessor (T1 a1, T2 a2)
 Create an AttributeAccessor using a pair of get functor and set methods from a class. More...
 
Ptr< const AttributeChecker > ns3::MakeVectorChecker (void)
 

Detailed Description

Attribute implementation for Vector3D.

See also
ns3::Vector3D

Typedef Documentation

typedef Vector3DChecker ns3::VectorChecker

Vector alias typedef for compatibility with mobility models.

Definition at line 176 of file vector.h.

typedef Vector3DValue ns3::VectorValue

Vector alias typedef for compatibility with mobility models.

Definition at line 171 of file vector.h.

Function Documentation

template<typename T1 >
ns3::Ptr< const ns3::AttributeAccessor > ns3::MakeVector3DAccessor ( T1  a1)

Create an AttributeAccessor for a class data member, or a lone class get functor or set method.

The get functor method should have a signature like

typedef U (T::*getter)(void) const

where T is the class and U is the type of the return value.

The set method should have one of these signatures:

typedef void (T::*setter)(U)
typedef bool (T::*setter)(U)

where T is the class and U is the type of the value to set the attribute to, which should be compatible with the specific AttributeValue type V which holds the value (or the type implied by the name Make<V>Accessor of this function.) In the case of a setter returning bool, the return value should be true if the value could be set successfully.

Template Parameters
V[explicit] (If present) The specific AttributeValue type to use to represent the Attribute. (If not present, the type V is implicit in the name of this function, as "Make<V>Accessor"
T1[deduced] The type of the class data member, or the type of the class get functor or set method.
Parameters
[in]a1The address of the data member, or the get or set method.
Returns
The AttributeAccessor
See also
AttributeAccessor

Definition at line 116 of file vector.h.

template<typename T1 , typename T2 >
ns3::Ptr< const ns3::AttributeAccessor > ns3::MakeVector3DAccessor ( T1  a1,
T2  a2 
)

Create an AttributeAccessor using a pair of get functor and set methods from a class.

The get functor method should have a signature like

typedef U (T::*getter)(void) const

where T is the class and U is the type of the return value.

The set method should have one of these signatures:

typedef void (T::*setter)(U)
typedef bool (T::*setter)(U)

where T is the class and U is the type of the value to set the attribute to, which should be compatible with the specific AttributeValue type V which holds the value (or the type implied by the name Make<V>Accessor of this function.) In the case of a setter returning bool, the return value should be true if the value could be set successfully.

In practice the setter and getter arguments can appear in either order, but setter first is preferred.

Template Parameters
V[explicit] (If present) The specific AttributeValue type to use to represent the Attribute. (If not present, the type V is implicit in the name of this function as "Make<V>Accessor"
T1[deduced] The type of the class data member, or the type of the class get functor or set method.
T2[deduced] The type of the getter class functor method.
Parameters
[in]a2The address of the class method to set the attribute.
[in]a1The address of the data member, or the get or set method.
Returns
The AttributeAccessor
See also
AttributeAccessor

Definition at line 116 of file vector.h.

Ptr< const AttributeChecker > ns3::MakeVector3DChecker ( void  )
Returns
The AttributeChecker.
See also
AttributeChecker

Definition at line 36 of file vector.cc.

Referenced by ns3::MakeVectorChecker().

+ Here is the caller graph for this function:

template<typename T1 >
ns3::Ptr< const ns3::AttributeAccessor > ns3::MakeVectorAccessor ( T1  a1)

Create an AttributeAccessor for a class data member, or a lone class get functor or set method.

The get functor method should have a signature like

typedef U (T::*getter)(void) const

where T is the class and U is the type of the return value.

The set method should have one of these signatures:

typedef void (T::*setter)(U)
typedef bool (T::*setter)(U)

where T is the class and U is the type of the value to set the attribute to, which should be compatible with the specific AttributeValue type V which holds the value (or the type implied by the name Make<V>Accessor of this function.) In the case of a setter returning bool, the return value should be true if the value could be set successfully.

Template Parameters
V[explicit] (If present) The specific AttributeValue type to use to represent the Attribute. (If not present, the type V is implicit in the name of this function, as "Make<V>Accessor"
T1[deduced] The type of the class data member, or the type of the class get functor or set method.
Parameters
[in]a1The address of the data member, or the get or set method.
Returns
The AttributeAccessor
See also
AttributeAccessor

Definition at line 193 of file vector.h.

Referenced by ns3::MobilityModel::GetTypeId().

+ Here is the caller graph for this function:

template<typename T1 , typename T2 >
ns3::Ptr< const ns3::AttributeAccessor > ns3::MakeVectorAccessor ( T1  a1,
T2  a2 
)

Create an AttributeAccessor using a pair of get functor and set methods from a class.

The get functor method should have a signature like

typedef U (T::*getter)(void) const

where T is the class and U is the type of the return value.

The set method should have one of these signatures:

typedef void (T::*setter)(U)
typedef bool (T::*setter)(U)

where T is the class and U is the type of the value to set the attribute to, which should be compatible with the specific AttributeValue type V which holds the value (or the type implied by the name Make<V>Accessor of this function.) In the case of a setter returning bool, the return value should be true if the value could be set successfully.

In practice the setter and getter arguments can appear in either order, but setter first is preferred.

Template Parameters
V[explicit] (If present) The specific AttributeValue type to use to represent the Attribute. (If not present, the type V is implicit in the name of this function as "Make<V>Accessor"
T1[deduced] The type of the class data member, or the type of the class get functor or set method.
T2[deduced] The type of the getter class functor method.
Parameters
[in]a2The address of the class method to set the attribute.
[in]a1The address of the data member, or the get or set method.
Returns
The AttributeAccessor
See also
AttributeAccessor

Definition at line 193 of file vector.h.

Ptr< const AttributeChecker > ns3::MakeVectorChecker ( void  )
Returns
The AttributeChecker.
See also
AttributeChecker

Definition at line 40 of file vector.cc.

References ns3::MakeVector3DChecker(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::MobilityModel::GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function: