Click or drag to resize

DPIObjectObjectInstance Class

Object instance base class.
Inheritance Hierarchy
SystemObject
  Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIServices
    Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIObject
      Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIObjectObjectInstance
        Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIRouter

Namespace:  Demo3D.PLC.Rockwell.Comms.DPI.Nodes
Assembly:  PLC (in PLC.dll) Version: 14.0.0.10531
Syntax
C#
public class ObjectInstance : DPIObject

The DPIObjectObjectInstance type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyClassId
The class id of an object.
(Inherited from DPIObject.)
Public propertyInstanceId
The instance id of an object.
(Inherited from DPIObject.)
Public propertyNode
The associated node in the DPI node hierarchy.
(Inherited from DPIObject.)
Public propertyNodeName
Override to provide a name for the node.
(Inherited from DPIObject.)
Public propertyNumLinks
Returns the number of links.
(Inherited from DPIObject.)
Public propertyParentClass
The parent class of an instance (or null).
Public propertyRouter
The DPI router instance.
(Inherited from DPIObject.)
Top
Methods
  NameDescription
Public methodAddChild
Add a class to an instance.
Public methodAllInstancesT
Find all instances of a specified sub class.
Public methodAllObjects
Returns all linked nodes.
(Inherited from DPIObject.)
Protected methodConstructNode
Initialize object properties.
(Inherited from DPIObject.)
Public methodDescendants
Return all descendants of this node.
(Inherited from DPIObject.)
Public methodFindClass(ClassID)
Find class with a specified id.
Public methodFindClassT(ClassID)
Find class with a spcified type and id.
Public methodFindInstance(ClassID, UInt32)
Find class instance by id.
Public methodFindInstanceT(ClassID, UInt32)
Find class instance by id.
Public methodGetAttribute
Service GetAttribute DPI request.
(Inherited from DPIServices.)
Public methodGetAttributeProperties
Returns all attribute properties (in GetAttributeAll order, ie not necessarily numerical order).
(Inherited from DPIServices.)
Public methodGetAttributeProperties(UInt32)
Return the attribute properties for one attribute.
(Inherited from DPIServices.)
Public methodGetAttributeValue
Read the value of one attribute and write it into the responseData.
(Inherited from DPIServices.)
Public methodInitialize
Initialize the object.
(Inherited from DPIObject.)
Public methodMissingNodeFirstChance
First chance to intercept a missing node. Return true to indicate that we added a node.
(Inherited from DPIObject.)
Public methodNotifyAddedHierarchy
Initialize object after its has been added to the hierarchy.
(Inherited from DPIObject.)
Public methodNotifyAllChildrenRemoved
Called to notify when all removable children have been removed.
(Inherited from DPIObject.)
Public methodNotifyAttributeSet
Callback to indicate that an attribute value has been set. Only called at the end of the protocol request after all attributes in the packet have been set.
(Inherited from DPIServices.)
Public methodNotifyChildAdded
Called to notify when a child object is added.
(Inherited from DPIObject.)
Public methodNotifyChildRemoved
Called to notify when a child object has been removed.
(Inherited from DPIObject.)
Public methodNotifyRemovedHierarchy
Called to notify when this object has been removed from the hierarchy.
(Inherited from DPIObject.)
Public methodRequestRemoveChild
Called to request permission to remove a child.
(Inherited from DPIObject.)
Public methodSetAttribute
Service SetAttribute DPI request.
(Inherited from DPIServices.)
Public methodSetAttributeValue
Set one attribute to the value read from requestData.
(Inherited from DPIServices.)
Public methodSetInstance(ClassID, UInt32)
Set the node id.
(Inherited from DPIObject.)
Public methodSetInstance(DPIObjectObjectClass, UInt32)
Set the node id.
Top
Events
  NameDescription
Public eventOnChildAdded
Occurs when a child object has been added.
(Inherited from DPIObject.)
Public eventOnChildRemoved
Occurs when a child object has been removed.
(Inherited from DPIObject.)
Top
See Also