DPIRouter Class |
The DPI router.
Inheritance HierarchySystemObject
Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIServices
Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIObject
Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIObjectObjectInstance
Demo3D.PLC.Rockwell.Comms.DPI.NodesDPIRouter
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
SyntaxC#
public abstract class DPIRouter : DPIObjectObjectInstance
The DPIRouter type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ClassId |
The class id of an object.
(Inherited from DPIObject.) |
| InstanceId |
The instance id of an object.
(Inherited from DPIObject.) |
| Node |
The associated node in the DPI node hierarchy.
(Inherited from DPIObject.) |
| NodeName |
Override to provide a name for the node.
(Inherited from DPIObject.) |
| NumLinks |
Returns the number of links.
(Inherited from DPIObject.) |
| ParentClass |
The parent class of an instance (or null).
(Inherited from DPIObjectObjectInstance.) |
| Router |
The DPI router instance.
(Inherited from DPIObject.) |
Methods| Name | Description | |
|---|---|---|
 | AddChild |
Add a class to an instance.
(Inherited from DPIObjectObjectInstance.) |
| AllInstancesT |
Find all instances of a specified sub class.
(Inherited from DPIObjectObjectInstance.) |
| AllObjects |
Returns all linked nodes.
(Inherited from DPIObject.) |
 | ConstructNode |
Initialize object properties.
(Inherited from DPIObject.) |
| Descendants |
Return all descendants of this node.
(Inherited from DPIObject.) |
| FindClass(ClassID) |
Find class with a specified id.
(Inherited from DPIObjectObjectInstance.) |
| FindInstanceT(ClassID, UInt32) |
Find class instance by id.
(Inherited from DPIObjectObjectInstance.) |
| GetAttribute |
Service GetAttribute DPI request.
(Inherited from DPIServices.) |
| GetAttributeProperties |
Returns all attribute properties (in GetAttributeAll order, ie not necessarily numerical order).
(Inherited from DPIServices.) |
| GetAttributeProperties(UInt32) |
Return the attribute properties for one attribute.
(Inherited from DPIServices.) |
| GetAttributeValue |
Read the value of one attribute and write it into the responseData.
(Inherited from DPIServices.) |
| Initialize |
Initialize the object.
(Inherited from DPIObject.) |
| MissingNodeFirstChance |
First chance to intercept a missing node.
Return true to indicate that we added a node.
(Inherited from DPIObject.) |
| NotifyAddedHierarchy |
Initialize object after its has been added to the hierarchy.
(Inherited from DPIObject.) |
| NotifyAllChildrenRemoved |
Called to notify when all removable children have been removed.
(Inherited from DPIObject.) |
| NotifyAttributeSet |
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.) |
| NotifyChildAdded |
Called to notify when a child object is added.
(Inherited from DPIObject.) |
| NotifyChildRemoved |
Called to notify when a child object has been removed.
(Inherited from DPIObject.) |
| NotifyRemovedHierarchy |
Called to notify when this object has been removed from the hierarchy.
(Inherited from DPIObject.) |
| RequestRemoveChild |
Called to request permission to remove a child.
(Inherited from DPIObject.) |
| SetAttribute |
Service SetAttribute DPI request.
(Inherited from DPIServices.) |
| SetAttributeValue |
Set one attribute to the value read from requestData.
(Inherited from DPIServices.) |
| SetInstance(ClassID, UInt32) |
Set the node id.
(Inherited from DPIObject.) |
| SetInstance(DPIObjectObjectClass, UInt32) |
Set the node id.
(Inherited from DPIObjectObjectInstance.) |
Events| Name | Description | |
|---|---|---|
 | OnChildAdded |
Occurs when a child object has been added.
(Inherited from DPIObject.) |
| OnChildRemoved |
Occurs when a child object has been removed.
(Inherited from DPIObject.) |
Remarks
The DPIRouter is the root of the DPI node tree.
From this node, you can navigate to any other node in the tree.
See Also