CParamMessage Class Reference

CParamMessage. More...

#include <ParamMessage.h>

Inheritance diagram for CParamMessage:

List of all members.

Public Member Functions
bool	getParamDirection ()
	getParamDirection
void	setParam (PARAMETER)
	setParam
PARAMETER	getParam () const
	getParam
void	setParamDirection (bool bSetting)
	setParamDirection
void	setValue (int32 value)
	setValue
int32	getValue () const
	getValue

---

Detailed Description

CParamMessage.

Description: The CParamMessage message class is associated with the parameter table. These messages have either a Get or Set 'direction', a parameter name, and a parameter value.

Limitations: None

---

Member Function Documentation

PARAMETER CParamMessage::getParam (   )  const [inline]

getParam Description: This function returns the PARAMETER value. Returns: PARAMETER Limitations: None

bool CParamMessage::getParamDirection (   )  [inline]

getParamDirection Description: This function returns the "direction" of the parameter message. Returns: bool: True = setting; False = fetching. Limitations: None

int CParamMessage::getValue (   )  const [inline]

getValue Description: This function returns the value associated with the param. Returns: int - the value. Limitations: None

void CParamMessage::setParam (  PARAMETER  p  )  [inline]

setParam Description: This function sets the value of the parameter field. Parameters: p  - The parameter value to set. Returns: void Limitations: None

void CParamMessage::setParamDirection (  bool  bSetting  )  [inline]

setParamDirection Description: This function sets the "direction" of the parameter message. Parameters: bSetting,:  True indicates that the recipient should set the given parameter to the provided value. False indicates that the reciepient should return the value of the given parameter. Returns: void Limitations: None

void CParamMessage::setValue (  int32  value  )  [inline]

setValue Description: This function sets the value that is associated with the specified parameter Parameters: value  - the value to be set. Returns: void Limitations: None

---

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

• Message/ParamMessage.h

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver