itom
Loading...
Searching...
No Matches
ito::HWMeta Class Reference

Meta-information for Param of type HWPtr. More...

#include <paramMeta.h>

Inheritance diagram for ito::HWMeta:
ito::ParamMeta

Public Member Functions

 HWMeta (uint32 minType, ito::ByteArray category=ito::ByteArray())
 constructor
 
 HWMeta (const ito::ByteArray &hwAddInName, ito::ByteArray category=ito::ByteArray())
 constructor
 
 HWMeta (const HWMeta &cpy)
 < copy constructor
 
virtual bool operator== (const ParamMeta &other) const
 assignment operator
 
HWMetaoperator= (const HWMeta &rhs)
 returns type-bitmask which is minimally required by plugin-reference. Default 0.
 
uint32 getMinType () const
 returns name of specific hardware plugin
 
ito::ByteArray getHWAddInName () const
 
- Public Member Functions inherited from ito::ParamMeta
 ParamMeta (ito::ByteArray category=ito::ByteArray())
 constructor used by derived classes to indicate their real type
 
 ParamMeta (MetaRtti type, ito::ByteArray category=ito::ByteArray())
 
 ParamMeta (const ParamMeta &copy)
 
ParamMetaoperator= (const ParamMeta &rhs)
 destructor
 
virtual ~ParamMeta ()
 returns runtime type information value
 
MetaRtti getType () const
 returns category name of this parameter (default: empty ByteArray)
 
ito::ByteArray getCategory () const
 
void setCategory (const ito::ByteArray &category)
 
bool operator!= (const ParamMeta &other) const
 

Private Attributes

uint32 m_minType
 type-bitmask which is minimally required. default: 0
 
ito::ByteArray m_HWName
 zero-terminated name of specific plugin-name or invalid if not defined
 

Additional Inherited Members

- Public Types inherited from ito::ParamMeta
enum  MetaRtti {
  rttiUnknown = 0 , rttiCharMeta = 1 , rttiIntMeta = 2 , rttiDoubleMeta = 3 ,
  rttiStringMeta = 4 , rttiHWMeta = 5 , rttiDObjMeta = 6 , rttiIntArrayMeta = 7 ,
  rttiDoubleArrayMeta = 8 , rttiCharArrayMeta = 9 , rttiIntervalMeta = 10 , rttiDoubleIntervalMeta = 11 ,
  rttiRangeMeta = 12 , rttiRectMeta = 13 , rttiStringListMeta = 14
}
 Runtime type information. More...
 
enum  tRepresentation {
  Linear = 0x0001 , Logarithmic = 0x0002 , Boolean = 0x0004 , PureNumber = 0x0008 ,
  HexNumber = 0x0010 , IPV4Address = 0x0020 , MACAddress = 0x0040 , UnknownRepresentation = 0x0080
}
 The representation of number types indicates the type of widget that is suited best to display and change the value. More...
 
- Protected Attributes inherited from ito::ParamMeta
MetaRtti m_type
 
ito::ByteArray m_category
 optional category name of this parameter
 

Detailed Description

Meta-information for Param of type HWPtr.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::HWPtr, that is an instance of another hardware plugin. If set, it is possible to restrict the given hardware plugin to a specific type (e.g. dataIO, dataIO + grabber, actuator...) and/or to limit it to a specific name of the plugin (e.g. SerialIO).

See also
ito::Param, ito::ParamMeta

Constructor & Destructor Documentation

◆ HWMeta() [1/2]

ito::HWMeta::HWMeta ( uint32 minType,
ito::ByteArray category = ito::ByteArray() )
explicit

constructor

creates HWMeta-information struct where you can pass a bitmask which consists of values of the enumeration ito::tPluginType. The plugin reference of the corresponding Param should then only accept plugins, where all bits are set, too.

See also
ito::Plugin, ito::tPluginType

◆ HWMeta() [2/2]

ito::HWMeta::HWMeta ( const ito::ByteArray & hwAddInName,
ito::ByteArray category = ito::ByteArray() )
explicit

constructor

creates HWMeta-information struct where you can pass a specific name of a plugin, which only is allowed by the corresponding plugin-instance.

See also
ito::Plugin copy constructor

creates HWMeta-information struct where you can pass a specific name of a plugin, which only is allowed by the corresponding plugin-instance.

See also
ito::Plugin

Member Function Documentation

◆ operator=()

HWMeta & ito::HWMeta::operator= ( const HWMeta & rhs)

returns type-bitmask which is minimally required by plugin-reference. Default 0.

See also
ito::tPluginType

◆ operator==()

bool ito::HWMeta::operator== ( const ParamMeta & other) const
virtual

assignment operator

Reimplemented from ito::ParamMeta.


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