This parameter handles serializing a bool parameter.
More...
#include <ParamSerializers.h>
Inherits IParamSerializer< bool >, and IDiscreteConverter< bool >.
|
| BooleanParamSerializer (std::string iFalseString="Off", std::string iTrueString="On") |
|
tresult | readFromStream (IBStreamer &iStreamer, ParamType &oValue) const override |
| This method should read from the stream and populate oValue accordingly (aka deserialization) More...
|
|
tresult | writeToStream (const ParamType &iValue, IBStreamer &oStreamer) const override |
| This method should write iValue to the stream (aka serialization) More...
|
|
void | writeToStream (ParamType const &iValue, std::ostream &oStream) const override |
| By default, this implementation simply writes the value to the stream IF it is possible (determined at compilation time). More...
|
|
virtual std::string | toString (ParamType const &iValue, int32 iPrecision) const |
|
This parameter handles serializing a bool parameter.
◆ BooleanParamSerializer()
◆ convertFromDiscreteValue()
tresult convertFromDiscreteValue |
( |
int32 |
iDiscreteValue, |
|
|
bool & |
oValue |
|
) |
| const |
|
inlineoverrideprivatevirtual |
◆ convertToDiscreteValue()
tresult convertToDiscreteValue |
( |
const bool & |
iValue, |
|
|
int32 & |
oDiscreteValue |
|
) |
| const |
|
inlineoverrideprivatevirtual |
◆ getStepCount()
int32 getStepCount |
( |
| ) |
const |
|
inlineoverrideprivatevirtual |
◆ readFromStream()
tresult readFromStream |
( |
IBStreamer & |
iStreamer, |
|
|
ParamType & |
oValue |
|
) |
| const |
|
inlineoverridevirtual |
This method should read from the stream and populate oValue
accordingly (aka deserialization)
- Returns
kResultOk
if reading was successful, kResultFalse
otherwise (or kNotImplemented
if not supported)
Reimplemented from IParamSerializer< bool >.
◆ writeToStream() [1/2]
tresult writeToStream |
( |
const ParamType & |
iValue, |
|
|
IBStreamer & |
oStreamer |
|
) |
| const |
|
inlineoverridevirtual |
This method should write iValue
to the stream (aka serialization)
- Returns
kResultOk
if writing was successful, kResultFalse
otherwise (or kNotImplemented
if not supported)
Reimplemented from IParamSerializer< bool >.
◆ writeToStream() [2/2]
void writeToStream |
( |
ParamType const & |
iValue, |
|
|
std::ostream & |
oStream |
|
) |
| const |
|
inlineoverridevirtual |
By default, this implementation simply writes the value to the stream IF it is possible (determined at compilation time).
Doesn't do anything if not. Subclasses can redefine this behavior.
Reimplemented from IParamSerializer< bool >.
◆ fFalseString
◆ fTrueString
The documentation for this class was generated from the following file: