GUIDOLib  1.7.7
Guido Engine Internal Documentation
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
TagParameterFloat Class Reference

The floating point parameter type for Guido Tags. More...

Inheritance diagram for TagParameterFloat:
TagParameter TagParameterInt

Public Member Functions

 TagParameterFloat (bool unittag)
 
 TagParameterFloat (float theFloat=0.f)
 
 TagParameterFloat (const TagParameterFloat &tpf)
 
virtual ~TagParameterFloat ()
 
virtual void print (std::ostream &out)
 
virtual void set (const TagParameterFloat &in)
 
void reset (float theFloat, const char *inUnit)
 
virtual float getUnitValue () const
 resets value, unit & unittag More...
 
void setUnit (const char *un)
 
virtual void setValue (const char *p)
 
virtual void setValue (float val)
 
virtual TagParametergetCopy () const
 
virtual bool copyValue (const TagParameter *tp)
 
virtual bool isFloat () const
 
const TYPE_FLOATPARAMETER getValue (float curLSPACE=50.0f) const
 
bool TagIsUnitTag () const
 
void setUnitTag ()
 
const char * getUnit () const
 
bool hasUnit () const
 
- Public Member Functions inherited from TagParameter
 TagParameter ()
 
virtual ~TagParameter ()
 
virtual void set (const TagParameter &in)
 
void setRequired (bool i)
 
void setIsAuto ()
 
void setByName ()
 
void setNoSet ()
 
void setByPos ()
 
void setBySet ()
 
void setName (const std::string &p)
 
const std::string & getName () const
 
bool TagIsRequired () const
 
bool TagIsSet () const
 
bool TagIsSetByPosition () const
 
bool TagIsSetByName () const
 
bool TagIsSetByAuto () const
 
bool TagIsNotSet () const
 
virtual bool isString () const
 
virtual bool isInt () const
 
virtual bool isRGBValue () const
 

Static Public Member Functions

static bool convertValue (float value, double &toValue, const char *unit, float curLSPACE=50.0f)
 
static TagParameterFloatcast (TagParameter *inTag)
 
static const TagParameterFloatcast (const TagParameter *inTag)
 

Public Attributes

bool fUnittag
 

Protected Attributes

std::string fUnit
 
TYPE_FLOATPARAMETER fValue
 

Additional Inherited Members

- Public Types inherited from TagParameter
enum  PARSEFLAG {
  SETBYPOSITION, SETBYNAME, SETBYAUTO, NOTSET,
  SET
}
 

Detailed Description

The floating point parameter type for Guido Tags.

Constructor & Destructor Documentation

◆ TagParameterFloat() [1/3]

TagParameterFloat::TagParameterFloat ( bool  unittag)

◆ TagParameterFloat() [2/3]

TagParameterFloat::TagParameterFloat ( float  theFloat = 0.f)

◆ TagParameterFloat() [3/3]

TagParameterFloat::TagParameterFloat ( const TagParameterFloat tpf)

◆ ~TagParameterFloat()

virtual TagParameterFloat::~TagParameterFloat ( )
inlinevirtual

Member Function Documentation

◆ cast() [1/2]

static const TagParameterFloat* TagParameterFloat::cast ( const TagParameter inTag)
inlinestatic

◆ cast() [2/2]

static TagParameterFloat* TagParameterFloat::cast ( TagParameter inTag)
inlinestatic

◆ convertValue()

static bool TagParameterFloat::convertValue ( float  value,
double &  toValue,
const char *  unit,
float  curLSPACE = 50.0f 
)
static

◆ copyValue()

virtual bool TagParameterFloat::copyValue ( const TagParameter tp)
virtual

Reimplemented from TagParameter.

Reimplemented in TagParameterInt.

◆ getCopy()

virtual TagParameter* TagParameterFloat::getCopy ( ) const
inlinevirtual

Reimplemented from TagParameter.

Reimplemented in TagParameterInt.

◆ getUnit()

const char* TagParameterFloat::getUnit ( ) const
inline

◆ getUnitValue()

virtual float TagParameterFloat::getUnitValue ( ) const
inlinevirtual

resets value, unit & unittag

◆ getValue()

const TYPE_FLOATPARAMETER TagParameterFloat::getValue ( float  curLSPACE = 50.0f) const

◆ hasUnit()

bool TagParameterFloat::hasUnit ( ) const
inline

◆ isFloat()

virtual bool TagParameterFloat::isFloat ( ) const
inlinevirtual

Reimplemented from TagParameter.

◆ print()

virtual void TagParameterFloat::print ( std::ostream &  out)
virtual

Reimplemented from TagParameter.

Reimplemented in TagParameterInt.

◆ reset()

void TagParameterFloat::reset ( float  theFloat,
const char *  inUnit 
)

◆ set()

virtual void TagParameterFloat::set ( const TagParameterFloat in)
virtual

◆ setUnit()

void TagParameterFloat::setUnit ( const char *  un)

◆ setUnitTag()

void TagParameterFloat::setUnitTag ( )
inline

◆ setValue() [1/2]

virtual void TagParameterFloat::setValue ( const char *  p)
virtual

Reimplemented from TagParameter.

Reimplemented in TagParameterInt.

◆ setValue() [2/2]

virtual void TagParameterFloat::setValue ( float  val)
inlinevirtual

◆ TagIsUnitTag()

bool TagParameterFloat::TagIsUnitTag ( ) const
inline

Member Data Documentation

◆ fUnit

std::string TagParameterFloat::fUnit
protected

◆ fUnittag

bool TagParameterFloat::fUnittag

◆ fValue

TYPE_FLOATPARAMETER TagParameterFloat::fValue
protected

Guido Project Copyright © 2019 Grame-CNCM