CIPObject Class |
Represents one CIP object.
Inheritance HierarchySystemObject
Demo3D.PLC.Comms.CIP.NodesCIPServices
Demo3D.PLC.Comms.CIP.NodesCIPObject
Demo3D.PLC.Comms.CIP.NodesCIPObjectObjectClass
Demo3D.PLC.Comms.CIP.NodesCIPObjectObjectInstance
Demo3D.PLC.Comms.CIP.NodesCIPServices
Demo3D.PLC.Comms.CIP.NodesCIPObject
Demo3D.PLC.Comms.CIP.NodesCIPObjectObjectClass
Demo3D.PLC.Comms.CIP.NodesCIPObjectObjectInstance
Namespace: Demo3D.PLC.Comms.CIP.Nodes
Assembly: PLC (in PLC.dll) Version: 15.0.2.11458
SyntaxC#
public abstract class CIPObject : CIPServices, IAttributeDatabase
The CIPObject type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Attributes |
Extended attributes.
|
 | ClassId |
The class id of an object.
|
| InstanceId |
The instance id of an object.
|
| Node |
The associated node in the CIP node hierarchy.
|
| NodeName |
Override to provide a name for the node.
|
| NotImplementedPaths |
A list of paths that we know we'll get asked for but are deliberately not implemented.
|
| NumLinks |
Returns the number of links.
|
| Router |
The message router instance.
|
Methods| Name | Description | |
|---|---|---|
 | AllObjects |
Returns all linked nodes.
|
 | ConstructNode |
Initialize object properties.
|
| CreateValue |
Create an attribute value of the specified dimensions.
|
| Descendants |
Return all descendants of this node.
|
| 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. |
| GetAttributeList |
Service GetAttributeList CIP request.
(Overrides CIPServicesGetAttributeList(MessageContext, OutgoingResponse, IPacketReader).) |
| GetAttributeProperties |
Returns all attribute properties (in GetAttributeAll order, ie not necessarily numerical order).
|
| GetAttributeProperties(UInt32) |
Return the attribute properties for one attribute.
|
| GetAttributesAll |
Service GetAttributesAll CIP request.
(Overrides CIPServicesGetAttributesAll(MessageContext, OutgoingResponse).) |
| GetAttributeSingle |
Service GetAttributeSingle CIP request.
(Overrides CIPServicesGetAttributeSingle(MessageContext, OutgoingResponse, UInt32).) |
| GetAttributeValue |
Read the value of one attribute and write it into the responseData.
|
| GetAttributeValues |
Return the values of all the attributes.
|
| Initialize |
Initialize the object.
|
| MissingAttributeFirstChance |
First chance to intercept a missing attribute.
Return true to indicate that we added an attribute.
|
| NotifyAddedHierarchy |
Initialize object after its has been added to the hierarchy.
|
| NotifyAllChildrenRemoved |
Called to notify when all removable children have been removed.
|
| 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.
|
| NotifyChildAdded |
Called to notify when a child object is added.
|
| NotifyChildRemoved |
Called to notify when a child object has been removed.
|
| NotifyRemovedHierarchy |
Called to notify when this object has been removed from the hierarchy.
|
| OverrideNodePropertyBag |
Return the property bag for this node.
|
| RequestRemoveChild |
Called to request permission to remove a child.
|
| 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.
(Overrides CIPServicesSetAttributeList(MessageContext, OutgoingResponse, IPacketReader).) |
| SetAttributesAll |
Service SetAttributesAll CIP request.
(Overrides CIPServicesSetAttributesAll(MessageContext, OutgoingResponse, IPacketReader).) |
| SetAttributeSingle |
Service SetAttributeSingle CIP request.
(Overrides CIPServicesSetAttributeSingle(MessageContext, OutgoingResponse, IPacketReader, UInt32).) |
| SetAttributeValue |
Set one attribute to the value read from requestData.
|
| SetInstance |
Set the node id.
|
| SetupBus |
Setup the bus configuration.
|
Events| Name | Description | |
|---|---|---|
 | OnChildAdded |
Occurs when a child object has been added.
|
| OnChildRemoved |
Occurs when a child object has been removed.
|
Extension Methods| Name | Description | |
|---|---|---|
 | FindAttributeValue |
Find an attribute value by id.
(Defined by AttributeDatabaseExtensions.) |
| FindByteArrayAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindByteAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindDIntAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindDWordAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindLIntAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindLRealAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindLWordAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindOrAddAttributeValue(AttributeValue, Boolean) | Overloaded.
Find or add an attribute value.
(Defined by AttributeDatabaseExtensions.)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. |
| FindOrAddAttributeValue(UInt32, DataDimensions, Boolean) | Overloaded.
Find or add an attribute value.
(Defined by AttributeDatabaseExtensions.)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. |
| FindRealAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindShortStringAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| FindWordAttribute |
Finds an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetByteArrayAttribute(UInt32, Int32) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetByteArrayAttribute(UInt32, Int32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetByteArrayAttribute(UInt32, Int32, BufferSegment) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetByteAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetByteAttribute(UInt32, Byte) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetDIntAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetDIntAttribute(UInt32, Int32) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetDWordAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetDWordAttribute(UInt32, UInt32) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLIntAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLIntAttribute(UInt32, Int64) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLRealAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLRealAttribute(UInt32, Double) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLWordAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetLWordAttribute(UInt32, UInt64) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetRealAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetRealAttribute(UInt32, Single) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetShortStringAttribute(UInt32, Int32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetShortStringAttribute(UInt32, Int32, String) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetWordAttribute(UInt32, Boolean) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
| GetWordAttribute(UInt32, UInt16) | Overloaded.
Finds or creates an attribute.
(Defined by AttributeDatabaseExtensions.) |
See Also