1.1.2.1.12 OcaStringSensor

Class Hierarchy:

OcaRoot : OcaWorker : OcaSensor : OcaBasicSensor : OcaStringSensor

class OcaStringSensor : OcaBasicSensor 

UTF-8 string sensor.

Properties:

static const OcaClassID ClassID = "1.1.2.1.12"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaUint16 MaxLen

Maximum length of the returned string. May be readonly in some implementations.

This property has id 5.2.

OcaString Reading

The string. New name as of v3 of this class.

This property has id 5.1.

Properties inherited from 1.1.2.1 OcaBasicSensor:

Methods:

OcaStatus GetReading(OcaString &Reading)

Gets the entire string.

This method has id 5.1.

Reading: Output parameter.

OcaStatus GetMaxLen(OcaUint16 &maxLen)

Gets the maximum number of bytes that may be returned.

This method has id 5.2.

maxLen: Output parameter.

OcaStatus SetMaxLen(OcaUint16 maxLen)

Sets the maximum number of bytes that the object may return.

This method has id 5.3.

maxLen: Input parameter.

Methods inherited from 1.1.2.1 OcaBasicSensor: