MMDevice
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MM::PropertyCollection Class Reference

An array of properties supported by a device. More...

#include <Property.h>

Public Member Functions

 PropertyCollection ()
 
 ~PropertyCollection ()
 
int CreateProperty (const char *name, const char *value, PropertyType eType, bool bReadOnly, ActionFunctor *pAct=0, bool isPreInitProperty=false)
 
int RegisterAction (const char *name, ActionFunctor *fpAct)
 
int SetAllowedValues (const char *name, std::vector< std::string > &values)
 
int ClearAllowedValues (const char *name)
 
int AddAllowedValue (const char *name, const char *value, long data)
 
int AddAllowedValue (const char *name, const char *value)
 
int GetPropertyData (const char *name, const char *value, long &data)
 
int GetCurrentPropertyData (const char *name, long &data)
 
int Set (const char *propName, const char *Value)
 
int Get (const char *propName, std::string &val) const
 
PropertyFind (const char *name) const
 
std::vector< std::string > GetNames () const
 
unsigned GetSize () const
 
bool GetName (unsigned uIdx, std::string &strName) const
 
int UpdateAll ()
 
int ApplyAll ()
 
int Update (const char *Name)
 
int Apply (const char *Name)
 

Detailed Description

An array of properties supported by a device.

Constructor & Destructor Documentation

◆ PropertyCollection()

MM::PropertyCollection::PropertyCollection ( )

◆ ~PropertyCollection()

MM::PropertyCollection::~PropertyCollection ( )

Member Function Documentation

◆ AddAllowedValue() [1/2]

int MM::PropertyCollection::AddAllowedValue ( const char * name,
const char * value )

◆ AddAllowedValue() [2/2]

int MM::PropertyCollection::AddAllowedValue ( const char * name,
const char * value,
long data )

◆ Apply()

int MM::PropertyCollection::Apply ( const char * Name)

◆ ApplyAll()

int MM::PropertyCollection::ApplyAll ( )

◆ ClearAllowedValues()

int MM::PropertyCollection::ClearAllowedValues ( const char * name)

◆ CreateProperty()

int MM::PropertyCollection::CreateProperty ( const char * name,
const char * value,
MM::PropertyType eType,
bool bReadOnly,
MM::ActionFunctor * pAct = 0,
bool isPreInitProperty = false )

◆ Find()

MM::Property * MM::PropertyCollection::Find ( const char * name) const

◆ Get()

int MM::PropertyCollection::Get ( const char * propName,
std::string & val ) const

◆ GetCurrentPropertyData()

int MM::PropertyCollection::GetCurrentPropertyData ( const char * name,
long & data )

◆ GetName()

bool MM::PropertyCollection::GetName ( unsigned uIdx,
std::string & strName ) const

◆ GetNames()

std::vector< std::string > MM::PropertyCollection::GetNames ( ) const

◆ GetPropertyData()

int MM::PropertyCollection::GetPropertyData ( const char * name,
const char * value,
long & data )

◆ GetSize()

unsigned MM::PropertyCollection::GetSize ( ) const

◆ RegisterAction()

int MM::PropertyCollection::RegisterAction ( const char * name,
MM::ActionFunctor * fpAct )

◆ Set()

int MM::PropertyCollection::Set ( const char * propName,
const char * Value )

◆ SetAllowedValues()

int MM::PropertyCollection::SetAllowedValues ( const char * name,
std::vector< std::string > & values )

◆ Update()

int MM::PropertyCollection::Update ( const char * Name)

◆ UpdateAll()

int MM::PropertyCollection::UpdateAll ( )

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