ciGain Class Reference

Public Member Functions
double	getGain ()
void	setGain (double gain)
double	getLevel ()
void	setLevel (double level)
bool	archive (char *filepath)
bool	serialize (char *filepath)
ciGain	operator= (ciGain &obj)
	ciGain ()
	ciGain (ciGain &obj)
virtual	~ciGain ()

Protected Attributes
double	m_gain
double	m_level

Detailed Description

ciGain class declaration

Constructor & Destructor Documentation

ciGain::ciGain

(

)

Default constructor.

ciGain::ciGain

(

ciGain &

obj

)

Copy constructor.

Parameters

obj	- ciGain object to be copied.

virtual ciGain::~ciGain ( )

virtual

Member Function Documentation

double ciGain::getGain ( )

inline

gets the gain.

Returns

The gain.

References m_gain.

void ciGain::setGain ( double  gain )

inline

sets the gain.

Parameters

gain	- The gain to be assigned.

Returns

void.

References m_gain.

double ciGain::getLevel ( )

inline

gets the level parameter.

Returns

The level parameter.

References m_level.

void ciGain::setLevel ( double  level )

inline

sets the level parameter.

Parameters

level

- The value of the level parameter to be assigned .

Returns

void.

References m_level.

bool ciGain::archive

(

char *

filepath

)

Description:

Saves the ciGain object to file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciGain::serialize

(

char *

filepath

)

Description:

Loads the ciGain object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

ciGain ciGain::operator=

(

ciGain &

obj

)

Assignment operator.

Parameters

obj	- ciGain object to be assigned.

Returns

The assigned ciGain object.

Member Data Documentation

double ciGain::m_gain

protected

gain

Referenced by getGain(), and setGain().

double ciGain::m_level

protected

level.

Referenced by getLevel(), and setLevel().

---

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

• ciGain.h