DOFInterfaceID ClassOpenDOF Object Access Library
Represents an Interface Identifier (IID).
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFInterfaceID

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
[SerializableAttribute]
public sealed class DOFInterfaceID : DOFValue, 
	DOFImmutable, IComparable<DOFInterfaceID>

The DOFInterfaceID type exposes the following members.

Methods

  NameDescription
Public methodCompareTo
Compares two DOFInterfaceIDs byte-by-byte until the shortest length.
Public methodStatic membercreate(Byte)
Construct an interface identifier using a byte array.
Public methodStatic membercreate(String)
Construct an interface identifier using the standard format.
Public methodStatic membercreate(Byte, Int64)
Construct an interface identifier by specifying a registry and an identifier.
Public methodStatic membercreate(Byte, Int32)
Construct an interface identifier using a byte array, starting at an offset into the array.
Public methodStatic membercreate(DOFMarshalContext, Object, DOFPacket)
Construct an interface identifier from serial form.
Public methodEquals (Overrides ObjectEquals(Object).)
Public methodgetByteLength
Get the length of the identifier, including the registry and length byte.
Public methodgetBytes
Get the interface identifier as a byte array.
Public methodgetDOFType
Gets the DOFType of an interface (the same as DOFType.IID).
Public methodGetHashCode
Compute hash code.
(Overrides ObjectGetHashCode.)
Public methodgetIdentifier
Get the InterfaceID identifier, which is unique to a registry.
Public methodgetRegistry
Get the identifier's registry number.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodisCompatibleWith
Public methodisWildcard
Return true if the interface identifier represents a wildcard.
Public methodmarshal
Write the value of the IID as a DOFValue.
Public methodtoStandardString
Get a standard string representation of this DOFInterfaceID.
Public methodToString
Get a string representation of this object.
(Overrides ObjectToString.)
Top
Fields

  NameDescription
Public fieldStatic memberMAX_IDENTIFIER
The max registry identifier.
Public fieldStatic memberMAX_REGISTRY
The max registry value.
Public fieldStatic memberTEST_REGISTRY
The "test" or "development" registry.
Public fieldStatic memberTYPE
This is the default type for all interface identifiers.
Public fieldStatic memberWILDCARD
The wildcard DOFInterfaceID.
Top
Remarks

Represents an Interface Identifier (IID). Each OAP interface has a globally unique identifier associated with it.

Registry 63 is uncontrolled, and can be used during development and testing. There are no guarantees of uniqueness in registry 63. Interfaces in this registry are not registered.

The registry zero (0) is reserved for situations where a dynamic interface is required. There is no registration for these dynamic interfaces, and so conflicts may exist. Uses of this registry require approval by the DOF Technical Committee.

Other registry values must be registered with the DOF Technical Committee.

Constructing DOFInterfaceID:

DOFInterfaceID instances are constructed with the various create(byte[]) methods.

See Also

Reference