pgMsg< N > Class Template Reference
[pgGen -- General purpose module]

A general purpose message with fixed number parameters. More...

#include <pg_msg.h>

List of all members.

Classes

struct  MsgParam

Public Member Functions

 pgDefineException (ExceptionInvalidArgument)
 pgDefineException (ExceptionInvalidCall)
 pgDefineException (ExceptionInvalidType)
 pgMsg ()
 Constructs a pgMsg.
template<class T >
getParam (u8 index)
 Returns the parameter of the specified index.
template<class T >
void setParam (u8 index, T param)
 Sets the parameter to the specified value.


Detailed Description

template<u8 N>
class pgMsg< N >

A general purpose message with fixed number parameters.

Template Parameters:
N The number of parameters. This value must be more than zero.

Member Function Documentation

template<u8 N>
template<class T >
T pgMsg< N >::getParam ( u8  index  )  [inline]

Returns the parameter of the specified index.

Template Parameters:
T The type of the parameter.
Parameters:
[in] index The index of a parameter.
Returns:
The parameter of the specified index.

template<u8 N>
template<class T >
void pgMsg< N >::setParam ( u8  index,
param 
) [inline]

Sets the parameter to the specified value.

Template Parameters:
T The type of the parameter.
Parameters:
[in] index The index of a parameter.
[in] param The value of the parameter.


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

Generated on Sat Aug 15 11:24:38 2009 for Pogolyn by  doxygen 1.5.8