MessageRouter Class

The message router.

Inheritance Hierarchy

SystemObject
  Demo3D.PLC.Comms.CIP.NodesCIPServices
    Demo3D.PLC.Comms.CIP.NodesCIPObject
      Demo3D.PLC.Comms.CIP.NodesCIPObjectObjectInstance
        Demo3D.PLC.Comms.CIP.NodesMessageRouter

Namespace: Demo3D.PLC.Comms.CIP.Nodes
Assembly: PLC (in PLC.dll) Version: 19.00.00

Syntax

Copy

public abstract class MessageRouter : CIPObjectObjectInstance

The MessageRouter type exposes the following members.

Constructors

	Name	Description
	MessageRouter	Constructs a MessageRouter.

Top

Properties

	Name	Description
	Attributes	Extended attributes. (Inherited from CIPObject)
	ClassId	The class id of an object. (Inherited from CIPObject)
	EPATH	EPATH containing class and instance id. (Inherited from CIPObjectObjectInstance)
	InstanceId	The instance id of an object. (Inherited from CIPObject)
	IOEntry	The IO configuration tree entry for this device/module.
	MissingClassFirstChanceFunc	First chance to intercept a missing node. Passes the id of the missing node. Return true to indicate that we added a node. (Inherited from CIPObjectObjectInstance)
	Node	The associated node in the CIP node hierarchy. (Inherited from CIPObject)
	NodeName	Override to provide a name for the node. (Inherited from CIPObject)
	NotImplementedPaths	A list of paths that we know we'll get asked for but are deliberately not implemented. (Inherited from CIPObject)
	NumLinks	Returns the number of links. (Inherited from CIPObject)
	ParentClass	The parent class of an instance (or null). (Inherited from CIPObjectObjectInstance)
	Router	The message router instance. (Inherited from CIPObject)

Top

Methods

	Name	Description
	AddChild	Add a class to an instance. (Inherited from CIPObjectObjectInstance)
	AllInstancesT	Find all instances of a specified sub class. (Inherited from CIPObjectObjectInstance)
	AllObjects	Returns all linked nodes. (Inherited from CIPObject)
	ConstructNode	Initialize object properties. (Inherited from CIPObject)
	CreateAttributeList	Common interpretation of the data part of a Create service request. The service data is the same format as the SetAttributeList, but doesn't return the same SetAttributeList response. (Inherited from CIPObjectObjectInstance)
	CreateValue	Create an attribute value of the specified dimensions. (Inherited from CIPObject)
	Descendants	Return all descendants of this node. (Inherited from CIPObject)
	FindAddOrUpdateAttributeValue	Add or update an attribute value. If an attribute value with the specified id does not exist, then the function 'create' is called to create a new attribute value. If the 'create' function is null then no new attribute value is added. If an attribute value with the specified id already exists, then the function 'update' (if not null) is called to update the attribute value. (Inherited from CIPObject)
	FindClass(ClassID)	Find class with a specified id. (Inherited from CIPObjectObjectInstance)
	FindInstanceT(ClassID, UInt32, Boolean)	Find class instance by id. (Inherited from CIPObjectObjectInstance)
	GetAttributeList	Service GetAttributeList CIP request. (Inherited from CIPObject)
	GetAttributeProperties	Returns all attribute properties (in GetAttributeAll order, ie not necessarily numerical order). (Inherited from CIPObject)
	GetAttributeProperties(UInt32)	Return the attribute properties for one attribute. (Inherited from CIPObject)
	GetAttributesAll	Service GetAttributesAll CIP request. (Inherited from CIPObject)
	GetAttributeSingle	Service GetAttributeSingle CIP request. (Inherited from CIPObject)
	GetAttributeValue	Read the value of one attribute and write it into the responseData. (Inherited from CIPObject)
	GetAttributeValues	Return the values of all the attributes. (Inherited from CIPObject)
	Initialize	Initialize the object. (Inherited from CIPObject)
	MissingClassFirstChance	First chance to intercept a missing node. Return true to indicate that we added a node. (Inherited from CIPObjectObjectInstance)
	NotifyAddedHierarchy	Initialize object after its has been added to the hierarchy. (Inherited from CIPObject)
	NotifyAllChildrenRemoved	Called to notify when all removable children have been removed. (Inherited from CIPObject)
	NotifyAttributesSet	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 CIPObject)
	NotifyChildAdded	Called to notify when a child object is added. (Inherited from CIPObject)
	NotifyChildRemoved	Called to notify when a child object has been removed. (Inherited from CIPObject)
	NotifyRemovedHierarchy	Called to notify when this object has been removed from the hierarchy. (Inherited from CIPObject)
	OverrideNodePropertyBag	Return the property bag for this node. (Inherited from CIPObject)
	RequestRemoveChild	Called to request permission to remove a child. (Inherited from CIPObject)
	ServiceErrorStatus	Return error code for a service that's not supported by this node. (Inherited from CIPServices)
	ServiceRequest(MessageContext, OutgoingResponseContainer, IncomingRequest)	Service a request. (Inherited from CIPServices)
	ServiceRequest(MessageContext, OutgoingResponseContainer, IncomingRequest, EPATHLogicalPath, ServiceRequestHandler)	Try to service a request where we couldn't traverse the entire logical EPATH. Route will contain the remaining elements of the path that need to be resolved. (Inherited from CIPServices)
	SetAttributeList	Service SetAttributeList CIP request. (Inherited from CIPObject)
	SetAttributesAll	Service SetAttributesAll CIP request. (Inherited from CIPObject)
	SetAttributeSingle	Service SetAttributeSingle CIP request. (Inherited from CIPObject)
	SetAttributeValue	Set one attribute to the value read from requestData. (Inherited from CIPObject)
	SetInstance(ClassID, UInt32)	Set the node id. (Inherited from CIPObject)
	SetInstance(CIPObjectObjectClass, UInt32)	Set the node id. (Inherited from CIPObjectObjectInstance)
	SetupBus	Setup the bus configuration. (Inherited from CIPObject)

Top

Events

	Name	Description
	OnChildAdded	Occurs when a child object has been added. (Inherited from CIPObject)
	OnChildRemoved	Occurs when a child object has been removed. (Inherited from CIPObject)

Top

Remarks

The Message Router is the root of the CIP node tree. From this node, you can navigate to any other node in the tree. For example, various objects can be reached:


            using Demo3D.PLC.Comms.CIP.Nodes;

            using Demo3D.PLC.Comms.CIP.Nodes.Motion;

            using Demo3D.PLC.Rockwell.Comms.CIP.Nodes;


            var identity   = mr.FindInstance{Identity}(ClassID.Identity, 1);                       // Get the Identity object.

            var timeSync   = mr.FindInstance{TimeSync}(ClassID.TimeSync, 1);                       // Get the TimeSync object.

            var mda        = mr.FindInstance{MotionDeviceAccess}(ClassID.CIPMotion, driveNumber);  // Get the MDA instance for a specified drive.

            var parameters = mr.FindClass{ParameterClass}(ClassID.Parameter).Parameters;           // Get the parameters for the device.

See Identity, TimeSync, MotionDeviceAccess, and ParameterClass.

Reference

Demo3D.PLC.Comms.CIP.Nodes Namespace