Jamba C++ API 7.5.0
Loading...
Searching...
No Matches
BooleanParamSerializer Class Reference

This parameter handles serializing a bool parameter. More...

#include <ParamSerializers.h>

Inherits IParamSerializer< bool >, and IDiscreteConverter< bool >.

Public Member Functions

 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).
tresult writeToStream (const ParamType &iValue, IBStreamer &oStreamer) const override
 This method should write iValue to the stream (aka serialization).
void writeToStream (ParamType const &iValue, std::ostream &oStream) const override
Public Member Functions inherited from IParamSerializer< bool >
virtual std::string toString (ParamType const &iValue, int32 iPrecision) const

Protected Attributes

std::string fFalseString
std::string fTrueString

Private Member Functions

tresult convertFromDiscreteValue (int32 iDiscreteValue, bool &oValue) const override
tresult convertToDiscreteValue (const bool &iValue, int32 &oDiscreteValue) const override
int32 getStepCount () const override

Additional Inherited Members

Public Types inherited from IParamSerializer< bool >
using ParamType

Detailed Description

This parameter handles serializing a bool parameter.

Constructor & Destructor Documentation

◆ BooleanParamSerializer()

BooleanParamSerializer ( std::string iFalseString = "Off",
std::string iTrueString = "On" )
inlineexplicit

Member Function Documentation

◆ convertFromDiscreteValue()

tresult convertFromDiscreteValue ( int32 iDiscreteValue,
bool & oValue ) const
inlineoverrideprivatevirtual

Implements IDiscreteConverter< bool >.

◆ convertToDiscreteValue()

tresult convertToDiscreteValue ( const bool & iValue,
int32 & oDiscreteValue ) const
inlineoverrideprivatevirtual

Implements IDiscreteConverter< bool >.

◆ getStepCount()

int32 getStepCount ( ) const
inlineoverrideprivatevirtual

Implements IDiscreteConverter< bool >.

◆ 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
inlineoverride

Member Data Documentation

◆ fFalseString

std::string fFalseString
protected

◆ fTrueString

std::string fTrueString
protected
The documentation for this class was generated from the following file: