Abstract base class from which the application network classes inherit.
static
readonly
OcaClassID ClassID
= 1.4
Level: 1 Index: 1
This property is an override of the OcaRoot property.
Level: 1 Index: 2
This property is an override of the OcaRoot property.
Level: 2 Index: 1
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.
static
OcaONo Owner
Level: 2 Index: 2
Object number of block that contains this network.
Level: 2 Index: 3
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.
Level: 2 Index: 4
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.
Level: 2 Index: 5
Operational state of the network.
Level: 2 Index: 6
Most recent error code. 0=no error.
Properties inherited from OcaRoot
OcaApplicationNetwork::GetLabel (
)
→ (
OcaString Label)
Level: 2 Index: 1
Gets the network's user-specified label. Return status indicates whether the operation was successful.
OcaApplicationNetwork::SetLabel (
OcaString Label )
Level: 2 Index: 2
Sets the network's user-specified label. Return status indicates whether the operation was successful.
OcaApplicationNetwork::GetOwner (
)
→ (
OcaONo Owner)
Level: 2 Index: 3
Gets the ONo of this network's containing block. Return status indicates whether the operation was successful.
Level: 2 Index: 4
Gets the network's IDAdvertised. Return status indicates whether the operation was successful.
Level: 2 Index: 5
Sets the network's IDAdvertised. Return status indicates whether the operation was successful.
Level: 2 Index: 6
Retrieves the list of this network's system interface descriptor. Return status indicates whether the list was successfully retrieved.
Level: 2 Index: 7
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.
Level: 2 Index: 8
Retrieves the network's state. Return status indicates whether the status was successfully retrieved.
OcaApplicationNetwork::GetErrorCode (
)
→ (
OcaUint16 ErrorCode)
Level: 2 Index: 9
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.
Level: 2 Index: 10
Control the application network. Return value indicates success of command execution.
OcaApplicationNetwork::GetPath (
)
→ (
OcaNamePath NamePath, OcaONoPath ONoPath)
Level: 2 Index: 11
Returns path from given object down to root. The return value indicates whether the operation succeeded.