1.6 OcaNetworkInterface

Class Hierarchy:

OcaRoot : OcaNetworkInterface

class OcaNetworkInterface : OcaRoot

Represents the device’s connection to a data network.

Properties:

OcaAdaptationData ActiveNetworkSettings

Network-type-specific settings currently in effect.

This property has id 2.8.

OcaAdaptationIdentifier AdaptationIdentifier

Null string in the base class. Value will be overridden in subclasses by the identifier of the Adaptation that defined the respective child class.

This property has id 2.7.

static const OcaClassID ClassID = "1.6"

This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

This property is an override of the OcaRoot property.

This property has id 1.2.

OcaBoolean Enabled

True if and only if this network is available for input and/or output.

This property has id 2.3.

OcaUint16 ErrorCode

Most recent error code. 0=no error.

This property has id 2.12.

OcaUint16 GroupID

Arbitrary ID of network group to which this network interface belongs. Useful for identifying redundant network sets. An ID value of zero means this network interface does not belong to any group.

This property has id 2.5.

OcaString Label

User-defined label. No programmatic significance. Read/write.

This property has id 2.1.

OcaBoolean NetworkSettingsPending

Readonly; TRUE when a new TargetNetworkSettings value has been provided but not applied; set to TRUE by method SetTargetNetworkSettings(…), set to FALSE when the target network settings are applied, either by the execution of a Start command or by some other means.

This property has id 2.10.

const OcaONo Owner

Object number of block that contains this object. Read-only.

This property has id 2.2.

OcaUint16 Precedence

Used for redundant groups. 0 means undefined. 1 is highest priority, 2 is next, and so on.

This property has id 2.6.

OcaNetworkInterfaceStatus Status

Operational status of this network interface

This property has id 2.11.

OcaString SystemIoInterfaceName

Name of the network I/O interface provided to AES70 by the Device system environment.

This property has id 2.4.

OcaAdaptationData TargetNetworkSettings

Network-type-specific settings waiting to be applied. Shall be applied by a Start or Restart command or by a Device-initiated reset. The value of this property may or may not survive a Device reset, depending on implementation.

This property has id 2.9.

Properties inherited from 1 OcaRoot:

Methods:

OcaStatus GetLabel(OcaString &Label)

Gets the value of the Label property.

This method has id 2.1.

  • Label: Output parameter.

OcaStatus SetLabel(OcaString Label)

Sets the value of the Label property.

This method has id 2.2.

  • Label: Input parameter.

OcaStatus GetOwner(OcaONo &Owner)

Gets the value of the Owner property.

This method has id 2.3.

  • Owner: Output parameter.

OcaStatus GetPath(OcaRolePath &RolePath, OcaONoPath &ONoPath)

Returns Role Path and ONo Path from the Root Block to this object. The return value indicates whether the operation succeeded.

This method has id 2.4.

OcaStatus GetEnabled(OcaBoolean &Enabled)

Gets the value of the Enabled property.

This method has id 2.5.

OcaStatus SetEnabled(OcaBoolean Enabled)

Sets the value of the Enabled property.

This method has id 2.6.

OcaStatus GetSystemIoInterfaceName(OcaString &Name)

Gets the system I/O interface name.

This method has id 2.7.

  • Name: Output parameter.

OcaStatus SetSystemIoInterfaceName(OcaString Identifier)

Sets the system I/O interface name.

This method has id 2.8.

OcaStatus GetGroupID(OcaUint16 &Id)

Gets the network group ID. Returns value of zero if this network does not belong to a group.

This method has id 2.9.

  • Id: Output parameter.

OcaStatus SetGroupID(OcaUint16 Id)

Sets the network group ID. An ID value of zero means this network interface does not belong to a group.

This method has id 2.10.

  • Id: Input parameter.

OcaStatus GetPrecedence(OcaUint8 &Precedence)

Gets the value of the Precedence property.

This method has id 2.11.

OcaStatus SetPrecedence(OcaUint8 Precedence)

Sets the value of the Precedence property.

This method has id 2.12.

OcaStatus GetAdaptationIdentifier(OcaString &Identifier)

Gets the identifier of the Adaptation this network object implements.

This method has id 2.13.

OcaStatus GetActiveNetworkSettings(OcaBlob &Settings)

Gets the value of property ActiveNetworkSettings.

This method has id 2.14.

OcaStatus GetTargetNetworkSettings(OcaBlob &Settings)

Gets the value of property TargetNetworkSettings.

This method has id 2.15.

OcaStatus SetTargetNetworkSettings(OcaBlob Settings)

Sets the value of property TargetNetworkSettings.

This method has id 2.16.

OcaStatus GetNetworkSettingsPending(OcaBoolean &Pending)

Gets the value of property NetworkSettingsPending.

This method has id 2.17.

OcaStatus GetStatus(OcaNetworkInterfaceStatus &Status)

Gets the network’s operational status.

This method has id 2.18.

OcaStatus GetErrorCode(OcaUint16 &ErrorCode)

Gets the most recent error code.

This method has id 2.19.

OcaStatus GetCounterSet(OcaCounterSet &CounterSet)

Get this object’s CounterSet.

This method has id 2.20.

OcaStatus GetCounter(OcaID16 CounterID, OcaCounter &Counter)

Gets the given counter from this object’s CounterSet.

This method has id 2.21.

OcaStatus AttachCounterNotifier(OcaID16 CounterID, OcaONo ONo)

Adds a notifier ONo to the Notifiers property of the designated counter.

This method has id 2.22.

OcaStatus DetachCounterNotifier(OcaID16 CounterID, OcaONo ONo)

Removes given notifier ONo from the Notifiers property of the designated counter.

This method has id 2.23.

OcaStatus ResetCounters()

Resets this object’s counterset. Sets all counters to their specified default values.

This method has id 2.24.

OcaStatus ApplyCommand(OcaNetworkInterfaceCommand Command)

Controls the network interface.

This method has id 2.25.

Methods inherited from 1 OcaRoot: