SDESItem Class Reference

#include <sdes.h>

List of all members.

---

Detailed Description

The class SDESItem is used for storing a source description item (type of description, description string) for an rtp end system.

Public Types
enum	SDES_ITEM_TYPE {   SDES_UNDEF = 0, SDES_CNAME = 1, SDES_NAME = 2, SDES_EMAIL = 3,   SDES_PHONE = 4, SDES_LOC = 5, SDES_TOOL = 6, SDES_NOTE = 7,   SDES_PRIV = 8 }
Public Member Functions
	SDESItem (const char *name=NULL)
	SDESItem (SDES_ITEM_TYPE type, const char *content)
	SDESItem (const SDESItem &sdesItem)
virtual	~SDESItem ()
SDESItem &	operator= (const SDESItem &sdesItem)
virtual cObject *	dup () const
virtual const char *	className () const
virtual std::string	info ()
virtual void	writeContents (std::ostream &os)
virtual SDES_ITEM_TYPE	type ()
virtual const char *	content ()
virtual int	length ()
Protected Attributes
SDES_ITEM_TYPE	_type
int	_length
const char *	_content

---

Member Enumeration Documentation

enum SDESItem::SDES_ITEM_TYPE

This enumeration holds the types of source description items as defined in the rfc. In this implementation only SDES_UNDEF and SDES_CNAME are usable. Enumeration values: SDES_UNDEF  SDES_CNAME  SDES_NAME  SDES_EMAIL  SDES_PHONE  SDES_LOC  SDES_TOOL  SDES_NOTE  SDES_PRIV  { SDES_UNDEF = 0, SDES_CNAME = 1, SDES_NAME = 2, SDES_EMAIL = 3, SDES_PHONE = 4, SDES_LOC = 5, SDES_TOOL = 6, SDES_NOTE = 7, SDES_PRIV = 8 };

---

Constructor & Destructor Documentation

SDESItem::SDESItem (  const char *  name = NULL  )

Default constructor. : cObject(name) { _type = SDES_UNDEF; _length = 2; _content = ""; };

SDESItem::SDESItem (  SDES_ITEM_TYPE  type, const char *  content )

Constructor which sets the entry. : cObject() { _type = type; _content = content; // an sdes item requires one byte for the type field, // one byte for the length field and bytes for // the content string _length = 2 + strlen(_content); };

SDESItem::SDESItem (  const SDESItem &  sdesItem  )

Copy constructor. : cObject() { setName(sdesItem.name()); operator=(sdesItem); };

SDESItem::~SDESItem (   )  [virtual]

Destructor. { };

---

Member Function Documentation

const char * SDESItem::className (   )  const [virtual]

Returns the class name "SDESItem". { return "SDESItem"; };

const char * SDESItem::content (   )  [virtual]

Returns the stored sdes string. { return opp_strdup(_content); };

cObject * SDESItem::dup (   )  const [virtual]

Duplicates theis SDESItem by calling the copy constructor. { return new SDESItem(*this); };

std::string SDESItem::info (   )  [virtual]

Writes a short info about this SDESItem into the given string. { std::stringstream out; out << "SDESItem=" << _content; return out.str(); };

int SDESItem::length (   )  [virtual]

This method returns the size of this SDESItem in bytes as it would be in the real world. { // bytes needed for this sdes item are // one byte for type, one for length // and the string return _length + 2; };

SDESItem & SDESItem::operator= (  const SDESItem &  sdesItem  )

Assignment operator. { cObject::operator=(sdesItem); _type = sdesItem._type; _length = sdesItem._length; _content = opp_strdup(sdesItem._content); return *this; };

SDESItem::SDES_ITEM_TYPE SDESItem::type (   )  [virtual]

Returns the type of this sdes item. { return _type; };

void SDESItem::writeContents (  std::ostream &  os  )  [virtual]

Writes an info about this SDESItem into the give output stream. { os << "SDESItem:" << endl; os << " type = " << _type << endl; os << " content = " << _content << endl; };

---

Member Data Documentation

const char* SDESItem::_content [protected]

The sdes string.

int SDESItem::_length [protected]

The length of this SDESItem.

SDES_ITEM_TYPE SDESItem::_type [protected]

The type of this SDESItem.

---

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

• sdes.h
• sdes.cc

---