# Frost::s_bool_t< T > Class Template Reference

Base type : boolean. More...

`#include <frost_utils_bool.h>`

List of all members.

## Public Types

typedef const bool &(s_bool_t::* | MemberFn )() const

## Public Member Functions

| s_bool_t ()
| s_bool_t (const T &bValue)
template<class N >
| s_bool_t (const s_str_t< N > &sValue)
const T & | Get () const
| Returns a const reference to the boolean.
T & | GetR ()
| Returns a reference to the boolean.
bool | operator! () const
| operator MemberFn () const
s_bool_t | operator== (const s_bool_t &bValue) const
s_bool_t | operator!= (const s_bool_t &bValue) const
s_bool_t & | operator= (const s_bool_t &bValue)

## Static Public Member Functions

static s_bool_t | Random ()
| Returns a random boolean.

## Static Public Attributes

static const string_element * | BOOL_TRUE = "true"
static const string_element * | BOOL_ONE = "1"
static const string_element * | BOOL_YES = "yes"
static T | bDummy

## Private Attributes

T | bValue_

## Detailed Description

### template<class T>
class Frost::s_bool_t< T >

Base type : boolean.

Frost's base types are made to allow simpler manipulation of numbers, booleans and strings. They simplify conversions (mostly to string), allow easy access to math/string functions and implements new functions that are not present in the standard libraries.

Note:
  This class doesn't need to be a template, as there is only one boolean type in C++. But it is delays the compilation of the class.

Definition at line 17 of file frost_utils_bool.h.

## Member Typedef Documentation

template<class T>

typedef const bool&(s_bool_t::* Frost::s_bool_t< T >::MemberFn)() const

Definition at line 45 of file frost_utils_bool.h.

## Constructor & Destructor Documentation

template<class T >

Frost::s_bool_t< T >::s_bool_t | ( |  | ) | `[inline]`

Definition at line 7 of file frost_utils_bool_impl.cpp.

template<class T>

Frost::s_bool_t< T >::s_bool_t | ( | const T & | bValue | ) | `[inline]`

Definition at line 13 of file frost_utils_bool_impl.cpp.

template<class T>
template<class N >

Frost::s_bool_t< T >::s_bool_t | ( | const s_str_t< N > & | sValue | ) | `[inline, explicit]`

Definition at line 26 of file frost_utils_bool.h.

## Member Function Documentation

template<class T>

const T& Frost::s_bool_t< T >::Get | ( |  | ) | const`[inline]`

Returns a const reference to the boolean.

Returns:
  A const reference to the boolean

Definition at line 36 of file frost_utils_bool.h.

template<class T>

T& Frost::s_bool_t< T >::GetR | ( |  | ) | `[inline]`

Returns a reference to the boolean.

Returns:
  A reference to the boolean

Definition at line 41 of file frost_utils_bool.h.

template<class T >

Frost::s_bool_t< T >::operator MemberFn | ( |  | ) | const`[inline]`

Definition at line 25 of file frost_utils_bool_impl.cpp.

template<class T >

bool Frost::s_bool_t< T >::operator! | ( |  | ) | const`[inline]`

Definition at line 19 of file frost_utils_bool_impl.cpp.

template<class T >

s_bool_t< T > Frost::s_bool_t< T >::operator!= | ( | const s_bool_t< T > & | bValue | ) | const`[inline]`

Definition at line 40 of file frost_utils_bool_impl.cpp.

template<class T >

s_bool_t< T > & Frost::s_bool_t< T >::operator= | ( | const s_bool_t< T > & | bValue | ) | `[inline]`

Definition at line 46 of file frost_utils_bool_impl.cpp.

template<class T >

s_bool_t< T > Frost::s_bool_t< T >::operator== | ( | const s_bool_t< T > & | bValue | ) | const`[inline]`

Definition at line 34 of file frost_utils_bool_impl.cpp.

template<class T >

s_bool_t< T > Frost::s_bool_t< T >::Random | ( |  | ) | `[inline, static]`

Returns a random boolean.

Returns:
  Either 'true' or 'false' (50% each).

Definition at line 56 of file frost_utils_bool_impl.cpp.

## Member Data Documentation

template<class T>

T Frost::s_bool_t< T >::bDummy`[static]`

Definition at line 57 of file frost_utils_bool.h.

template<class T>

const string_element * Frost::s_bool_t< T >::BOOL_ONE = "1"`[inline, static]`

Definition at line 55 of file frost_utils_bool.h.

template<class T>

const string_element * Frost::s_bool_t< T >::BOOL_TRUE = "true"`[inline, static]`

Definition at line 54 of file frost_utils_bool.h.

template<class T>

const string_element * Frost::s_bool_t< T >::BOOL_YES = "yes"`[inline, static]`

Definition at line 56 of file frost_utils_bool.h.

template<class T>

T Frost::s_bool_t< T >::bValue_`[private]`

Definition at line 66 of file frost_utils_bool.h.

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

- D:/Programmation/Sources/Tensor2/Utils/include/frost_utils_bool.h
- D:/Programmation/Sources/Tensor2/Utils/src/frost_utils_bool_impl.cpp