(n)-position single-pole switch.
static
readonly
OcaClassID ClassID
= 1.1.1.4
Level: 1 Index: 1
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.
Level: 1 Index: 2
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.
Level: 4 Index: 1
The current position of the switch. Positions shall be numbered from minPosition to (including) maxPosition. If the object does not return the optional parameters minPosition and maxPosition in its GetPosition method the positions shall be numbered from 1 to n.
Level: 4 Index: 2
Vector of switch position names. Supplied by controller.
Level: 4 Index: 3
Vector of booleans which enable or disable corresponding switch positions. Default values are a construction parameter. The usual default value is True.
Properties inherited from OcaWorker
Properties inherited from OcaRoot
OcaSwitch::GetPosition (
)
→ (
OcaUint16 position, OcaUint16 minPosition, OcaUint16 maxPosition)
Level: 4 Index: 1
Gets the value of the Position property and, optionally, its implementation min and max. The return value indicates whether the data was successfully retrieved.
OcaSwitch::SetPosition (
OcaUint16 position )
Level: 4 Index: 2
Sets the value of the Position property. The return value indicates whether the property was successfully set.
OcaSwitch::GetPositionName (
OcaUint16 Index )
→ (
OcaString Name)
Level: 4 Index: 3
Gets the name assigned to a given switch position. The return value indicates whether the name was successfully retrieved.
OcaSwitch::SetPositionName (
OcaUint16 Index, OcaString Name )
Level: 4 Index: 4
Assigns a name to a given switch position. The return value indicates whether the name was successfully assigned.
OcaSwitch::GetPositionNames (
)
→ (
OcaList<OcaString> Names)
Level: 4 Index: 5
Gets list of names assigned to the switch's positions. The return value indicates whether the names were successfully retrieved.
OcaSwitch::SetPositionNames (
OcaList<OcaString> Names )
Level: 4 Index: 6
Assigns names to the switch's positions. The return value indicates whether the names were successfully assigned.
OcaSwitch::GetPositionEnabled (
OcaUint16 Index )
→ (
OcaBoolean enabled)
Level: 4 Index: 7
Gets the Enabled flag assigned to a given switch position. The return value indicates whether the flag was successfully retrieved.
OcaSwitch::SetPositionEnabled (
OcaUint16 Index, OcaBoolean enabled )
Level: 4 Index: 8
Sets the Enabled flag assigned to a given switch position. The return value indicates whether the flag was successfully set.
OcaSwitch::GetPositionEnableds (
)
→ (
OcaList<OcaBoolean> enableds)
Level: 4 Index: 9
Gets list of Enabled flags assigned to the switch's positions. The return value indicates whether the flags were successfully retrieved.
OcaSwitch::SetPositionEnableds (
OcaList<OcaBoolean> enableds )
Level: 4 Index: 10
Sets list of Enabled flags for the switch's positions. The return value indicates whether the flags were successfully set.