Click or drag to resize

CIPObject Class

Represents one CIP object.
Inheritance Hierarchy

Namespace: Demo3D.PLC.Comms.CIP.Nodes
Assembly: PLC (in PLC.dll) Version: 19.00.00
Syntax
C#
Copy
public abstract class CIPObject : CIPServices, 
	IAttributeDatabase

The CIPObject type exposes the following members.

Properties
 NameDescription
Protected propertyAttributes Extended attributes.
Public propertyClassId The class id of an object.
Public propertyInstanceId The instance id of an object.
Public propertyNode The associated node in the CIP node hierarchy.
Public propertyNodeName Override to provide a name for the node.
Public propertyNotImplementedPaths A list of paths that we know we'll get asked for but are deliberately not implemented.
Public propertyNumLinks Returns the number of links.
Public propertyRouter The message router instance.
Top
Methods
 NameDescription
Public methodAllObjects Returns all linked nodes.
Protected methodConstructNode Initialize object properties.
Public methodCreateValue Create an attribute value of the specified dimensions.
Public methodDescendants Return all descendants of this node.
Public methodFindAddOrUpdateAttributeValue 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.

Public methodGetAttributeList Service GetAttributeList CIP request.
(Overrides CIPServicesGetAttributeList(MessageContext, OutgoingResponse, IPacketReader))
Protected methodGetAttributeProperties Returns all attribute properties (in GetAttributeAll order, ie not necessarily numerical order).
Protected methodGetAttributeProperties(UInt32) Return the attribute properties for one attribute.
Public methodGetAttributesAll Service GetAttributesAll CIP request.
(Overrides CIPServicesGetAttributesAll(MessageContext, OutgoingResponse))
Public methodGetAttributeSingle Service GetAttributeSingle CIP request.
(Overrides CIPServicesGetAttributeSingle(MessageContext, OutgoingResponse, UInt32))
Protected methodGetAttributeValue Read the value of one attribute and write it into the responseData.
Public methodGetAttributeValues Return the values of all the attributes.
Public methodInitialize Initialize the object.
Public methodNotifyAddedHierarchy Initialize object after its has been added to the hierarchy.
Public methodNotifyAllChildrenRemoved Called to notify when all removable children have been removed.
Protected methodNotifyAttributesSet 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.
Public methodNotifyChildAdded Called to notify when a child object is added.
Public methodNotifyChildRemoved Called to notify when a child object has been removed.
Public methodNotifyRemovedHierarchy Called to notify when this object has been removed from the hierarchy.
Protected methodOverrideNodePropertyBag Return the property bag for this node.
Public methodRequestRemoveChild Called to request permission to remove a child.
Public methodServiceErrorStatus Return error code for a service that's not supported by this node.
(Inherited from CIPServices)
Public methodServiceRequest(MessageContext, OutgoingResponseContainer, IncomingRequest) Service a request.
(Inherited from CIPServices)
Public methodServiceRequest(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)
Public methodSetAttributeList Service SetAttributeList CIP request.
(Overrides CIPServicesSetAttributeList(MessageContext, OutgoingResponse, IPacketReader))
Public methodSetAttributesAll Service SetAttributesAll CIP request.
(Overrides CIPServicesSetAttributesAll(MessageContext, OutgoingResponse, IPacketReader))
Public methodSetAttributeSingle Service SetAttributeSingle CIP request.
(Overrides CIPServicesSetAttributeSingle(MessageContext, OutgoingResponse, IPacketReader, UInt32))
Protected methodSetAttributeValue Set one attribute to the value read from requestData.
Public methodSetInstance Set the node id.
Public methodSetupBus Setup the bus configuration.
Top
Events
 NameDescription
Public eventOnChildAdded Occurs when a child object has been added.
Public eventOnChildRemoved Occurs when a child object has been removed.
Top
Extension Methods
 NameDescription
Public Extension MethodFindAttributeValue Find an attribute value by id.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindByteArrayAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindByteAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindDIntAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindDWordAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindLIntAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindLRealAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindLWordAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindOrAddAttributeValue Find or add an attribute value.

If an attribute value with the specified id does not exist, then the specified attribute is added. If an attribute value with the specified id already exists, then the original attribute is returned.


(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindOrAddAttributeValue Find or add an attribute value.

If an attribute value with the specified id already exists, then it's returned. If an attribute value with the specified id does not exist, then a new attribute value is created.


(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindRealAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindShortStringAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodFindWordAttribute Finds an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetByteArrayAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetByteArrayAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetByteArrayAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetByteAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetByteAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetDIntAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetDIntAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetDWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetDWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLIntAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLIntAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLRealAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLRealAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetLWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetRealAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetRealAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetShortStringAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetShortStringAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Public Extension MethodGetWordAttribute Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions)
Top
See Also