MM::PropertyBase Class Reference

Base API for all device properties. More...

#include <Property.h>

Inherited by MM::Property.

Public Member Functions
virtual	~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
virtual bool	HasLimits () const =0
virtual double	GetLowerLimit () const =0
virtual double	GetUpperLimit () const =0
virtual bool	SetLimits (double lowerLimit, double upperLimit)=0
virtual void	SetSequenceable (long sequenceSize)=0
virtual long	GetSequenceMaxSize () const =0
virtual std::vector< std::string >	GetSequence () const =0
virtual int	ClearSequence ()=0
virtual int	AddToSequence (const char *value)=0
virtual int	SendSequence ()=0
virtual std::string	GetName () const =0

Detailed Description

Base API for all device properties.

This interface is used by action functors.

Constructor & Destructor Documentation

~PropertyBase()

virtual MM::PropertyBase::~PropertyBase ( )

inlinevirtual

Member Function Documentation

AddToSequence()

virtual int MM::PropertyBase::AddToSequence ( const char * value )

pure virtual

Implemented in MM::Property.

ClearSequence()

virtual int MM::PropertyBase::ClearSequence ( )

pure virtual

Implemented in MM::Property.

Get() [1/3]

virtual bool MM::PropertyBase::Get ( double & dVal ) const

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

Get() [2/3]

virtual bool MM::PropertyBase::Get ( long & lVal ) const

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

Get() [3/3]

virtual bool MM::PropertyBase::Get ( std::string & strVal ) const

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

GetLowerLimit()

virtual double MM::PropertyBase::GetLowerLimit ( ) const

pure virtual

Implemented in MM::Property.

GetName()

virtual std::string MM::PropertyBase::GetName ( ) const

pure virtual

Implemented in MM::Property.

GetSequence()

virtual std::vector< std::string > MM::PropertyBase::GetSequence ( ) const

pure virtual

Implemented in MM::Property.

GetSequenceMaxSize()

virtual long MM::PropertyBase::GetSequenceMaxSize ( ) const

pure virtual

Implemented in MM::Property.

GetType()

virtual PropertyType MM::PropertyBase::GetType ( )

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

GetUpperLimit()

virtual double MM::PropertyBase::GetUpperLimit ( ) const

pure virtual

Implemented in MM::Property.

HasLimits()

virtual bool MM::PropertyBase::HasLimits ( ) const

pure virtual

Implemented in MM::Property.

SendSequence()

virtual int MM::PropertyBase::SendSequence ( )

pure virtual

Implemented in MM::Property.

Set() [1/3]

virtual bool MM::PropertyBase::Set ( const char * Val )

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

Set() [2/3]

virtual bool MM::PropertyBase::Set ( double dVal )

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

Set() [3/3]

virtual bool MM::PropertyBase::Set ( long lVal )

pure virtual

Implemented in MM::StringProperty, MM::FloatProperty, and MM::IntegerProperty.

SetLimits()

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

pure virtual

Implemented in MM::Property, MM::FloatProperty, and MM::StringProperty.

SetSequenceable()

virtual void MM::PropertyBase::SetSequenceable ( long sequenceSize )

pure virtual

Implemented in MM::Property.

---

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

• Property.h