TPProto::Component Class Reference

A Frame to hold Components from the server. More...

#include <component.h>

Inheritance diagram for TPProto::Component:

List of all members.

Public Member Functions
	Component ()
	Default constructor.
virtual	~Component ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, asserts.
bool	unpackBuffer (Buffer *buf)
	Unpack from a Buffer. Unpacks the Component frame from the buffer.
uint32_t	getComponentId () const
	Gets the Component id.
uint64_t	getModTime () const
	Gets the last modification time of this Component.
std::set< uint32_t >	getCategories () const
	Gets the categories this Component is in.
std::string	getName () const
	Gets the name of this Component.
std::string	getDescription () const
	Gets the description of this Component.
std::string	getTpclRequirementsFunc () const
	Gets the TPCL Requirements function for this Component.
std::map< uint32_t, std::string >	getTpclPropertyValueFuncs () const
	Gets the Property instances functions for this Component.

---

Detailed Description

A Frame to hold Components from the server.

---

Member Function Documentation

void TPProto::Component::packBuffer

(

Buffer *

buf

)

[virtual]

Pack into a Buffer, asserts.

Packs this Component frame into the buffer. Since the frame only comes from the server, this method assert(0).

Parameters:

buf

Buffer to pack into, ignored.

Implements TPProto::Frame.

bool TPProto::Component::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack from a Buffer. Unpacks the Component frame from the buffer.

Parameters:

buf

The Buffer to unpack out of.

Returns:

True if sucessful, false otherwise.

Implements TPProto::Frame.

uint32_t TPProto::Component::getComponentId

(

)

const

Gets the Component id.

Returns:

The Component id number.

uint64_t TPProto::Component::getModTime

(

)

const

Gets the last modification time of this Component.

Returns:

The modtime.

std::set< uint32_t > TPProto::Component::getCategories

(

)

const

Gets the categories this Component is in.

Returns:

The set of categories.

std::string TPProto::Component::getName

(

)

const

Gets the name of this Component.

Returns:

The name of the Component.

std::string TPProto::Component::getDescription

(

)

const

Gets the description of this Component.

Returns:

The description of the Component.

std::string TPProto::Component::getTpclRequirementsFunc

(

)

const

Gets the TPCL Requirements function for this Component.

Returns:

The TPCL Requirements function for this Component.

std::map< uint32_t, std::string > TPProto::Component::getTpclPropertyValueFuncs

(

)

const

Gets the Property instances functions for this Component.

Returns:

The map of property id and tpcl value functions for the Component.

---

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

• tpproto/component.h
• tpproto/component.cpp

---