DOFObject.DefaultProvider Class

DOFObjectDefaultProvider Class

OpenDOF Object Access Library

The DefaultProvider class implements Provider . You can extend this class, rather than implementing Provider , when you do not need to further extend your class and you only wish to override a portion of the methods in the full Provider interface. For example, if the DOF interface you are providing contains only read-only properties, you can extend DefaultProvider and override only the get method, allowing calls to all other methods to be responded to by the parent DefaultProvider class. Using DefaultProvider for such implementations often results in much more compact and elegant code.

Inheritance Hierarchy

SystemObject
org.opendof.core.oalDOFObjectDefaultProvider

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

Syntax

Copy

public class DefaultProvider : DOFObjectProvider, 
	DOFOperationOperationListener

The DOFObjectDefaultProvider type exposes the following members.

Constructors

	Name	Description
	DOFObjectDefaultProvider	Initializes a new instance of the DOFObjectDefaultProvider class

Top

Methods

	Name	Description
	complete	Called when the library receives notification that an operation is complete.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	get	Called when the library generates a Get . Also called after the subscribe(Provide, Subscribe, Property, int) method returns when the library generates a Subscribe . Unless overridden, this method responds with an exception stating that get has not been implemented. For more information, see Provider.get(Provide, Get, Property) .
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	invoke	Called when the library generates a Invoke . Unless overridden, this method responds with an exception stating that invoke has not been implemented. For more information, see Provider.invoke(Provide, Invoke, Method, System.Collections.Generic.IList<E>) .
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	register	Called when the library generates a Register . Unless overridden, this method does nothing other than call Register.respond() . For more information, see Provider.register(Provide, Register, Event) .
	registerComplete	Called when a provider receives notification that a register operation is complete.
	session	Called when the library generates a Session . Unless overridden, this method responds with an exception stating that session has not been implemented. For more information, see Provider.session(Provide, Session, DOFObject, DOFInterfaceID, DOFObjectID, DOFInterfaceID) .
	sessionComplete	Called when a provider receives notification that a session is complete.
	set	Called when the library generates a Set . Unless overridden, this method responds with an exception stating that set has not been implemented. For more information, see Provider.set(Provide, Set, Property, DOFValue) .
	subscribe	Called when the library generates a Subscribe . Unless overridden, this method does nothing other than call Subscribe.respond() , which then triggers the get(Provide, Get, Property) method. For more information, see Provider.subscribe(Provide, Subscribe, Property, int) and Provider.get(Provide, Get, Property) .
	subscribeComplete	Called when a provider receives notification that a subscribe operation is complete.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

org.opendof.core.oal Namespace