IProperty is an interface class for setting and getting properties of a derived class. More...
#include <property.h>
Inheritance diagram for IProperty:
Public Member Functions | |
| virtual int | GetProperty (int property, long *value)=0 |
| Get the property value. | |
| virtual int | SetProperty (int property, long value)=0 |
| Set the property value. | |
Detailed Description
IProperty is an interface class for setting and getting properties of a derived class.
Member Function Documentation
| virtual int IProperty::GetProperty | ( | int | property, | |
| long * | value | |||
| ) | [pure virtual] |
Get the property value.
- Parameters:
-
property the numerical identifier of the property value the value of the property is written into this long pointer
- Returns:
- PROP_OK=success (0)
- PROP_ERROR=general error (-1)
- PROP_ERROR_NOT_SUPPORTED=property doesn't exist or isn't supported (-2)
Implemented in CQEAnalog, CQEGpioInt, CQEPower, and CTextLcd.
| virtual int IProperty::SetProperty | ( | int | property, | |
| long | value | |||
| ) | [pure virtual] |
Set the property value.
- Parameters:
-
property the numerical identifier of the property value the value of the property
- Returns:
- PROP_OK=success (0)
- PROP_ERROR=general error (-1)
- PROP_ERROR_NOT_SUPPORTED=property doesn't exist or isn't supported (-2)
- PROP_ERROR_READ_ONLY=property can only be read (-3)
- PROP_ERROR_ILLEGAL_VALUE=the value is not permitted (-4)
Implemented in CQEAnalog, CQEGpioInt, CQEPower, and CTextLcd.
The documentation for this class was generated from the following file:
Generated on Mon Oct 3 2011 15:36:31 for libqwerk by
1.7.1