base::Percent Class Reference

Percent. More...

#include <_src_base_percent.hh>

List of all members.

Public Member Functions
	Percent (void)
	Percent (uint percent)
void	operator= (uint percent)
	Assigning an out-of-range percent is an error.
	operator uint () const
void	operator+= (int n)
	These clamp.
void	operator-= (int n)
Private Member Functions
void	Set (uint percent)
	Set() is strict: it will fail if percent is out-of-range.
void	SetClamp (int percent)
	SetClamp() is lenient: it will clamp out-of-range values.
Private Attributes
uint	mPercent

---

Detailed Description

Percent.

operator+=() clamps for conveniently incrementing (rather than requiring every caller to duplicate clamp code). Assigning an invalid Percent is never clamped: that's always an error.

---

Constructor & Destructor Documentation

base::Percent::Percent

(

void

)

[inline]

base::Percent::Percent

(

uint

percent

)

[inline]

---

Member Function Documentation

base::Percent::operator uint

(

)

const [inline]

void base::Percent::operator+=

(

int

n

)

[inline]

These clamp.

void base::Percent::operator-=

(

int

n

)

[inline]

void base::Percent::operator=

(

uint

percent

)

[inline]

Assigning an out-of-range percent is an error.

void base::Percent::Set

(

uint

percent

)

[inline, private]

Set() is strict: it will fail if percent is out-of-range.

void base::Percent::SetClamp

(

int

percent

)

[inline, private]

SetClamp() is lenient: it will clamp out-of-range values.

---

Member Data Documentation

uint base::Percent::mPercent [private]

---

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

• _src_base_percent.hh