1.4 OcaApplicationNetwork

Class Hirarchy:

OcaRootOcaApplicationNetwork

class OcaApplicationNetwork : OcaRoot

Abstract base class from which the application network classes inherit.

Properties:

OcaClassID ClassID

This property is an override of the OcaRoot property.

This property has id 2.1.

OcaClassVersionNumber ClassVersion

This property is an override of the OcaRoot property.

This property has id 2.2.

OcaString Label

Specific label of the network. Can be used to provide human readable information about the network. The label can be get and set over any network.

This property has id 2.1.

OcaONo Owner

Object number of block that contains this network.

This property has id 2.2.

OcaApplicationNetworkServiceID ServiceID

Name or GUID that this device publishes in the network’s directory/discovery system to designate the services offered via this application network object. This may or may not be the same as the device’s host name, if any. For data network types that have host names (e.g. IP networks), the authoritative copy of the host name is in the system interface ID.

This property has id 2.3.

OcaList<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces

Collection of identifiers of system interface descriptor(s) used by the network. A “system interface” is the system service through which network traffic passes into and out of the device – e.g. a socket. The descriptor format is system and network dependent; for OCA purposes, it is maintained as a variable-length blob which the protocol does not inspect.

This property has id 2.4.

OcaApplicationNetworkState State

Operational state of the network.

This property has id 2.5.

OcaUint16 ErrorCode

Most recent error code. 0=no error.

This property has id 2.6.

Properties inherited from OcaRoot:

Methods:

OcaStatus GetLabel(OcaString &Label)

Gets the network’s user-specified label. Return status indicates whether the operation was successful.

This method has id 2.1.

Parameters

OcaString Label – Output parameter.

OcaStatus SetLabel(OcaString Label)

Sets the network’s user-specified label. Return status indicates whether the operation was successful.

This method has id 2.2.

Parameters

OcaString Label – Input parameter.

OcaStatus GetOwner(OcaONo &Owner)

Gets the ONo of this network’s containing block. Return status indicates whether the operation was successful.

This method has id 2.3.

Parameters

OcaONo Owner – Output parameter.

OcaStatus GetServiceID(OcaApplicationNetworkServiceID &Name)

Gets the network’s IDAdvertised. Return status indicates whether the operation was successful.

This method has id 2.4.

Parameters

OcaApplicationNetworkServiceID Name – Output parameter.

OcaStatus SetServiceID(OcaApplicationNetworkServiceID Name)

Sets the network’s IDAdvertised. Return status indicates whether the operation was successful.

This method has id 2.5.

Parameters

OcaApplicationNetworkServiceID Name – Input parameter.

OcaStatus GetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceDescriptor> &SystemInterfaces)

Retrieves the list of this network’s system interface descriptor. Return status indicates whether the list was successfully retrieved.

This method has id 2.6.

Parameters

OcaList<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces – Output parameter.

OcaStatus SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceDescriptor> Descriptors)

Sets the network’s System Interface Descriptor(s). Return status indicates whether the operation was successful. Optional method; System Interface Descriptor may be set at construction time.

This method has id 2.7.

Parameters

OcaList<OcaNetworkSystemInterfaceDescriptor> Descriptors – Input parameter.

OcaStatus GetState(OcaApplicationNetworkState &State)

Retrieves the network’s state. Return status indicates whether the status was successfully retrieved.

This method has id 2.8.

Parameters

OcaApplicationNetworkState State – Output parameter.

OcaStatus GetErrorCode(OcaUint16 &ErrorCode)

Retrieves the most recent error code. Return status indicates whether the operation was successful. Note that a second parameter ‘Reset’ is removed in v02 of this class.

This method has id 2.9.

Parameters

OcaUint16 ErrorCode – Output parameter.

OcaStatus Control(OcaApplicationNetworkCommand Command)

Control the application network. Return value indicates success of command execution.

This method has id 2.10.

Parameters

OcaApplicationNetworkCommand Command – Input parameter.

OcaStatus GetPath(OcaNamePath &NamePath, OcaONoPath &ONoPath)

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

This method has id 2.11.

Parameters
  • OcaNamePath NamePath – Output parameter.

  • OcaONoPath ONoPath – Output parameter.

Methods inherited from OcaRoot: