ns3::rapidnet::TupleAttribute Class Reference
[RapidNet Library]

Represents an attribute of a tuple. An attribute is a name-value pair. More...

#include <tuple-attribute.h>

Inheritance diagram for ns3::rapidnet::TupleAttribute:

Inheritance graph
[legend]
Collaboration diagram for ns3::rapidnet::TupleAttribute:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint32_t GetSerializedSize (void) const
 Returns the size in bytes when serialized.
virtual void Serialize (Buffer::Iterator &start) const
 Serializes the object for transmitting over the network inside a RapidNet header.
virtual uint32_t Deserialize (Buffer::Iterator &end)
 De-serializes the object that is embedded in a RapidNet header received from the network.
virtual string ToString ()
 Returns the string representation of the TupleAttribute.
string GetName () const
virtual Ptr< ValueGetValue () const
virtual ValueTypeId GetType () const
 Returns the type code.
virtual void SetValue (Ptr< Value > value)
 Sets the given value.
virtual bool ValueEquals (const Ptr< TupleAttribute > attr) const
 Returns true if the value this object is equal to the value of the given TupleAttribute object.
virtual bool Equals (const Ptr< TupleAttribute > attr) const
 Compares with the given TupleAttribute for equality.

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.
static bool Less (const Ptr< TupleAttribute > a1, const Ptr< TupleAttribute > a2)
 Compares the given two TupleAttribute objects and returns true if the first is "less" than the second. False otherwise.
static Ptr< TupleAttributeNew (string name="unnamed", Ptr< Value > value=Ptr< Value >(NULL))
 Factory method to create a new TupleAttribute object.
static Ptr< TupleAttributeNew (string name, Ptr< TupleAttribute > attr)
 A prototype method that creates a new TupleAttribute object with the given name and value set to a clone of the value of the given TupleAttribute object.

Protected Member Functions

void SetName (string name)
 Sets name to the the given string.


Detailed Description

Represents an attribute of a tuple. An attribute is a name-value pair.

TupleAttribute is a name-value pair. The name is a string value object and the value can be of any RapidNet value type. A

See also:
Tuple is a collection of TupleAttribute objects and maps them by their name.

Member Function Documentation

string ns3::rapidnet::TupleAttribute::GetName ( void   )  const [inline]

Returns:
The attribute name.

static TypeId ns3::rapidnet::TupleAttribute::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::Object.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Ptr< Value > ns3::rapidnet::TupleAttribute::GetValue ( void   )  const [inline, virtual]

Returns:
The attribute value.

static Ptr<TupleAttribute> ns3::rapidnet::TupleAttribute::New ( string  name = "unnamed",
Ptr< Value value = PtrValue >(NULL) 
) [static]

Factory method to create a new TupleAttribute object.

The default name is "unnamed" and default value set to a null pointer.

Referenced by SetName().


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

Generated on Fri Apr 9 15:01:12 2010 for NS-3 by  doxygen 1.5.8