Gray::cStreamProgressT< TYPE > Class Template Reference

#include <cStreamProgress.h>

Public Member Functions
	cStreamProgressT (TYPE nAmount=0, TYPE nTotal=0)
bool	isComplete () const
float	get_PercentFloat () const
int	get_PercentInt () const
bool	isValidPercent () const
void	InitZero ()

Public Attributes
TYPE	m_nAmount
	How far the stream has progressed toward m_nTotal. More...
TYPE	m_nTotal
	Total size of the stream. 0 = i have no idea how big the total is. More...

Detailed Description

template<typename TYPE = STREAM_POS_t>
class Gray::cStreamProgressT< TYPE >

How much of some total has been processed?

Constructor & Destructor Documentation

cStreamProgressT()

template<typename TYPE = STREAM_POS_t>

Gray::cStreamProgressT< TYPE >::cStreamProgressT ( TYPE  nAmount = 0, TYPE  nTotal = 0  )

inline

Member Function Documentation

get_PercentFloat()

template<typename TYPE = STREAM_POS_t>

float Gray::cStreamProgressT< TYPE >::get_PercentFloat ( ) const

inline

Get percent of total.

Returns

0.0f to 1.0f

get_PercentInt()

template<typename TYPE = STREAM_POS_t>

int Gray::cStreamProgressT< TYPE >::get_PercentInt ( ) const

inline

Returns

From 0 to 100. MULDIV

InitZero()

template<typename TYPE = STREAM_POS_t>

void Gray::cStreamProgressT< TYPE >::InitZero ( )

inline

isComplete()

template<typename TYPE = STREAM_POS_t>

bool Gray::cStreamProgressT< TYPE >::isComplete ( ) const

inline

isValidPercent()

template<typename TYPE = STREAM_POS_t>

bool Gray::cStreamProgressT< TYPE >::isValidPercent ( ) const

inline

Member Data Documentation

m_nAmount

template<typename TYPE = STREAM_POS_t>

TYPE Gray::cStreamProgressT< TYPE >::m_nAmount

How far the stream has progressed toward m_nTotal.

m_nTotal

template<typename TYPE = STREAM_POS_t>

TYPE Gray::cStreamProgressT< TYPE >::m_nTotal

Total size of the stream. 0 = i have no idea how big the total is.

---

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

• c:/Dennis/Source/Gray/GrayCore/include/cStreamProgress.h