MMDevice 70
MM::Property Class Reference

Property API with most of the Property mechanism implemented. More...

#include <Property.h>

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

Public Member Functions

 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 ()
Public Member Functions inherited from MM::PropertyBase
virtual PropertyType GetType ()=0
virtual bool Set (double dVal)=0
virtual bool Set (long lVal)=0
virtual bool Set (const char *Val)=0
virtual bool Get (double &dVal) const =0
virtual bool Get (long &lVal) const =0
virtual bool Get (std::string &strVal) const =0

Protected Attributes

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

Property API with most of the Property mechanism implemented.

Member Function Documentation

◆ AddToSequence()

int MM::Property::AddToSequence ( const char * value)
inlinevirtual

Implements MM::PropertyBase.

◆ ClearLimits()

void MM::Property::ClearLimits ( )
inline

Removes the limits, if any, so that any value is allowed again.

Unlike SetLimits() with an empty range, this is not an error and is not logged as one.

Referenced by CDeviceBase< T, U >::ClearPropertyLimits().

◆ ClearSequence()

int MM::Property::ClearSequence ( )
inlinevirtual

Implements MM::PropertyBase.

◆ GetLowerLimit()

double MM::Property::GetLowerLimit ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ GetName()

std::string MM::Property::GetName ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ GetSequence()

std::vector< std::string > MM::Property::GetSequence ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ GetSequenceMaxSize()

long MM::Property::GetSequenceMaxSize ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ GetUpperLimit()

double MM::Property::GetUpperLimit ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ HasLimits()

bool MM::Property::HasLimits ( ) const
inlinevirtual

Implements MM::PropertyBase.

◆ SendSequence()

int MM::Property::SendSequence ( )
inlinevirtual

Implements MM::PropertyBase.

◆ SetLimits()

bool MM::Property::SetLimits ( double lowerLimit,
double upperLimit )
inlinevirtual

Implements MM::PropertyBase.

◆ SetSequenceable()

void MM::Property::SetSequenceable ( long sequenceMaxSize)
virtual

Implements MM::PropertyBase.


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