1.2 OcaAgent

Class Hirarchy:

OcaRootOcaAgent

class OcaAgent : OcaRoot

Abstract base class for defining agents.

Properties:

OcaClassID ClassID

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 2.1.

OcaClassVersionNumber ClassVersion

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 2.2.

OcaString Label

User-specified label.

This property has id 2.1.

OcaONo Owner

Object number of block that contains this agent.

This property has id 2.2.

Properties inherited from OcaRoot:

Methods:

OcaStatus GetLabel(OcaString &Label)

Gets the value of the Label property. The return value indicates whether the property was successfully retrieved.

This method has id 2.1.

Parameters

OcaString Label – Output parameter.

OcaStatus SetLabel(OcaString Label)

Sets the value of the Label property. The return value indicates whether the property was successfully set.

This method has id 2.2.

Parameters

OcaString Label – Input parameter.

OcaStatus GetOwner(OcaONo &owner)

Gets the value of the Owner property. The return value indicates whether the property was successfully retrieved.

This method has id 2.3.

Parameters

OcaONo owner – Output parameter.

OcaStatus GetPath(OcaNamePath &NamePath, OcaONoPath &ONoPath)

Returns path from the given object down to root. The return value indicates whether the operation succeeded. Added in version 2.

This method has id 2.4.

Parameters
  • OcaNamePath NamePath – Output parameter.

  • OcaONoPath ONoPath – Output parameter.

Methods inherited from OcaRoot: