BooleanHolder Class Reference

List of all members.

Public Member Functions

 BooleanHolder (bool value)
 BooleanHolder ()

Public Attributes

bool mValue

Detailed Description

A Holder class for a Boolean that is used to store "out" and "inout" parameters in methods. If a method has a boolean as an "out" or "inout" parameter, the programmer must pass an instance of BooleanHolder as the corresponding parameter in the method invocation; for "inout" parameters, the programmer must also fill the "in" value.

If myBooleanHolder is an instance of BooleanHolder,
the value stored in its value field can be accessed with myBooleanHolder.mValue.

Constructor & Destructor Documentation

BooleanHolder (  ) 

The default constructor for BooleanHolder class

BooleanHolder ( bool  value  ) 

This constructor will intialize BooleanHolder class with specified boolean value.

Parameters:
value Boolean value

Member Data Documentation

bool mValue

This member variable is where the boolean value is stored.