trek::PacketItem Class Reference

This class is the abstraction of items that can be added to a Packet zone. More...

#include <packet_item.h>

Inherits trek::NamedItem.

Inherited by trek::DelimitedParameterCollection, trek::FormatCollection, trek::OrderedParameterCollection, trek::Packet, trek::ParameterCollection, and trek::RandomPacketCollection.

Public Member Functions
Constructors, Destructor, and Other Basic Methods
	PacketItem ()
	Default constructor of the class.
virtual	~PacketItem ()
	Class destructor. More...
void	operator= (PacketItem &right_side)
	Provides the equal operator.
virtual void	Init ()
	Initializes the object. More...
Public Member Functions inherited from trek::NamedItem
void	SetName (const char *input_ptr)
	Sets the name of the item. More...
void	SetAlias (const char *input)
	Sets the alias of the item. More...
void	SetShortDescription (const char *input_ptr)
	Sets the short description of the item. More...
void	SetLongDescription (const char *input_ptr)
	Sets the long description of the item. More...
void	SetUserDescription (const char *input_ptr)
	Sets the user description of the item. More...
void	SetOwner (const char *input_ptr)
	Sets the owner of the item. More...
void	SetPath (const char *input_ptr)
	Sets the path for the item. More...
const char *	GetName ()
	Returns the name of the item.
const char *	GetAlias ()
	Returns the alias of the item.
const char *	GetShortDescription ()
	Returns the short description of the item.
const char *	GetLongDescription ()
	Returns the long description of the item.
const char *	GetUserDescription ()
	Returns the user description of the item.
const char *	GetOwner ()
	Returns the owner of the item.
const char *	GetPath ()
	Returns the path for the item.
int32_t	AddAttribute (const char *name, const char *value)
	Adds an attribute to the item. More...
void	GetAttributeList (StringArray &attr_array)
	Gets a list of the attribute names. More...
int32_t	GetAttribute (const char *name, char *value, uint32_t &value_len)
	Get the value of the specified attribute. More...
	NamedItem ()
	Default constructor of the class.
	NamedItem (NamedItem &input)
	Copy constructor of the class.
virtual	~NamedItem ()
	Class destructor. More...
void	operator= (NamedItem &right_side)
	Provides the equal operator.
bool	operator== (NamedItem &right_side)
	Provides the == operator.

Detailed Description

This class is the abstraction of items that can be added to a Packet zone.

Constructor & Destructor Documentation

~PacketItem()

trek::PacketItem::~PacketItem ( )

virtual

Class destructor.

Removes all resources created with this instance of the class.

Member Function Documentation

Init()

void trek::PacketItem::Init ( )

virtual

Initializes the object.

This method can be called to reinitialize a packet item to its default configuration. It is useful if you want to reuse the same object.

Reimplemented from trek::NamedItem.

Reimplemented in trek::DelimitedParameterCollection, trek::FormatCollection, trek::OrderedParameterCollection, trek::Packet, trek::ParameterCollection, and trek::RandomPacketCollection.