OcaStringSensor

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaBasicSensor().

This class defines the properties

Name	JavaScript Type	AES70 Type
String	string	OcaString
MaxLen	number	OcaUint16

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, ReadingState, String and MaxLen.

class OcaStringSensor(objectNumber, device)

Text string sensor.

OcaStringSensor.OnMaxLenChanged

type: PropertyEvent.<number>

This event is emitted when the property MaxLen changes in the remote object. The property MaxLen is described in the AES70 standard as follows. Maximum length of the returned string. May be readonly in some implementations.

OcaStringSensor.OnStringChanged

type: PropertyEvent.<string>

This event is emitted when the property String changes in the remote object. The property String is described in the AES70 standard as follows. The string.

OcaStringSensor.GetMaxLen()

Gets the maximum number of bytes that may be returned. Returned status indicates success or failure of the retrieval.

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaStringSensor.GetString()

Gets the entire string. Return status indicates success or failure of the retrieval.

Returns

Promise.<string> – A promise which resolves to a single value of type string.

OcaStringSensor.SetMaxLen(maxLen)

Sets the maximum number of bytes that the object may return. Returned status indicates success or failure of the set.

Arguments

• maxLen (number) –

Returns

Promise.<void> –