DOFInterface ClassOpenDOF Object Access Library
A DOFInterface defines a set of possible interactions with a DOFObject, which is typically remote (across the network).
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFInterface

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

C#
[SerializableAttribute]
public class DOFInterface : DOFImmutable

The DOFInterface type exposes the following members.

Constructors

  NameDescription
Protected methodDOFInterface
Construct a DOFInterface from its constituent parts.
Top
Methods

  NameDescription
Public methodEquals
Returns true if the interfaces are equivalent, meaning that OAP cannot tell the difference between them.
(Overrides ObjectEquals(Object).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodfixup
Assigns the interface reference for every item in the interface.
Public methodgetBytes
Get the serialized form of the interface as a byte[].
Public methodgetEvent
Get an Event given its identifier.
Public methodgetEvents
Get the Events of this interface.
Public methodgetException
Get an Exception given its identifier.
Public methodgetExceptions
Get the Exceptions of this interface.
Public methodGetHashCode
Compute hash code.
(Overrides ObjectGetHashCode.)
Public methodgetInterfaceID
Get the interface ID.
Public methodgetMethod
Get a Method given its identifier.
Public methodgetMethods
Get the Methods of this interface.
Public methodgetProperties
Get the Properties of this interface.
Public methodgetProperty
Get a Property given its identifier.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodmarshal
Marshal, or output a binary representation of this type, into the specified packet.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Get a string representation of this object.
(Overrides ObjectToString.)
Top
Fields

  NameDescription
Protected fieldeventMap
The interface's events.
Protected fieldexceptionMap
The interface's exceptions.
Protected fieldinterfaceID
The interface identifier.
Protected fieldmethodMap
The interface's methods.
Protected fieldpropertyMap
The interface's properties.
Top
Remarks

A DOFInterface defines a set of possible interactions with a DOFObject, which is typically remote (across the network). Conceptually it is similar to interfaces in object-oriented programming languages such as Java or C#. It is composed of a set of Properties, Methods, Events and Exceptions, each with their parameter and type information.

A DOFObject that provides (or implements) a DOFInterface is called a Provider.

Must be created with a Builder . This class is immutable once built.

See Also

Reference

Provider