MMDevice 70
MM::FloatProperty Class Reference

Floating point property class (uses double type for value representation). More...

#include <Property.h>

Inheritance diagram for MM::FloatProperty:
MM::Property MM::PropertyBase

Public Member Functions

 FloatProperty (const char *name)
PropertyType GetType ()
bool Set (double val)
bool Set (long val)
bool Set (const char *val)
bool Get (double &val) const
bool Get (long &val) const
bool Get (std::string &val) const
bool SetLimits (double lowerLimit, double upperLimit)
Public Member Functions inherited from MM::Property
 Property (const char *name)
bool GetCached () const
void SetCached (bool bState=true)
bool GetReadOnly () const
void SetReadOnly (bool bState=true)
bool GetInitStatus () const
void SetInitStatus (bool init)
void RegisterAction (ActionFunctor *fpAction)
int Update ()
int Apply ()
std::vector< std::string > GetAllowedValues () const
void ClearAllowedValues ()
void AddAllowedValue (const char *value)
void AddAllowedValue (const char *value, long data)
bool IsAllowed (const char *value) const
bool GetData (const char *value, long &data) const
bool HasLimits () const
double GetLowerLimit () const
double GetUpperLimit () const
void ClearLimits ()
bool SetLimits (double lowerLimit, double upperLimit)
bool IsSequenceable ()
void SetSequenceable (long sequenceMaxSize)
long GetSequenceMaxSize () const
int ClearSequence ()
int AddToSequence (const char *value)
int SendSequence ()
std::string GetName () const
std::vector< std::string > GetSequence () const
int StartSequence ()
int StopSequence ()

Additional Inherited Members

Protected Attributes inherited from MM::Property
bool readOnly_
ActionFunctor * fpAction_
bool cached_
bool hasData_
bool initStatus_
bool limits_
bool sequenceable_
long sequenceMaxSize_
std::vector< std::string > sequenceEvents_
double lowerLimit_
double upperLimit_
std::map< std::string, long > values_
const std::string name_

Detailed Description

Floating point property class (uses double type for value representation).

Member Function Documentation

◆ Get() [1/3]

bool MM::FloatProperty::Get ( double & val) const
virtual

Implements MM::PropertyBase.

◆ Get() [2/3]

bool MM::FloatProperty::Get ( long & val) const
virtual

Implements MM::PropertyBase.

◆ Get() [3/3]

bool MM::FloatProperty::Get ( std::string & val) const
virtual

Implements MM::PropertyBase.

◆ GetType()

PropertyType MM::FloatProperty::GetType ( )
inlinevirtual

Implements MM::PropertyBase.

◆ Set() [1/3]

bool MM::FloatProperty::Set ( const char * val)
virtual

Implements MM::PropertyBase.

◆ Set() [2/3]

bool MM::FloatProperty::Set ( double val)
virtual

Implements MM::PropertyBase.

◆ Set() [3/3]

bool MM::FloatProperty::Set ( long val)
virtual

Implements MM::PropertyBase.

◆ SetLimits()

bool MM::FloatProperty::SetLimits ( double lowerLimit,
double upperLimit )
virtual

Implements MM::PropertyBase.


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