Click or drag to resize

ObjectClass Methods

The CIPObjectObjectClass type exposes the following members.

Methods
  NameDescription
Public methodAddChild
Add an instance to a class.
Public methodAllInstances
All instances.
Public methodAllInstancesT
All instances of a specified type.
Public methodAllObjects
Returns all linked nodes.
(Inherited from CIPObject.)
Protected methodConstructNode
Initialize object properties.
(Inherited from CIPObject.)
Protected methodCreateInstance
Create a new instance of the class.
Public methodCreateValue
Create an attribute value of the specified dimensions.
(Inherited from CIPObject.)
Public methodDescendants
Return all descendants of this node.
(Inherited from CIPObject.)
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.

(Inherited from CIPObject.)
Public methodFindInstance
Find object with a specified id.
Public methodGetAttributeList
Service GetAttributeList CIP request.
(Inherited from CIPObject.)
Protected methodGetAttributeProperties
Return all attribute properties (in GetAttributeAll order, ie not necessarily numerical order).
(Overrides CIPObjectGetAttributeProperties.)
Protected methodGetAttributeProperties(UInt32)
Return the attribute properties for one attribute.
(Inherited from CIPObject.)
Public methodGetAttributesAll
Service GetAttributesAll CIP request.
(Inherited from CIPObject.)
Public methodGetAttributeSingle
Service GetAttributeSingle CIP request.
(Inherited from CIPObject.)
Protected methodGetAttributeValue
Read the value of one attribute and write it into the responseData.
(Overrides CIPObjectGetAttributeValue(MessageContext, IPacketWriter, UInt32).)
Public methodGetAttributeValues
Return the values of all the attributes.
(Inherited from CIPObject.)
Public methodInitialize
Initialize the object.
(Inherited from CIPObject.)
Protected methodMissingAttributeFirstChance
First chance to intercept a missing attribute. Return true to indicate that we added an attribute.
(Inherited from CIPObject.)
Public methodMissingInstanceFirstChance
First chance to intercept a missing node. Return true to indicate that we added a node.
Public methodNotifyAddedHierarchy
Initialize object after its has been added to the hierarchy.
(Inherited from CIPObject.)
Public methodNotifyAllChildrenRemoved
Called to notify when all removable children have been removed.
(Inherited from CIPObject.)
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.
(Inherited from CIPObject.)
Public methodNotifyChildAdded
Called to notify when a child object is added.
(Inherited from CIPObject.)
Public methodNotifyChildRemoved
Called to notify when a child object has been removed.
(Inherited from CIPObject.)
Public methodNotifyRemovedHierarchy
Called to notify when this object has been removed from the hierarchy.
(Inherited from CIPObject.)
Protected methodOverrideNodePropertyBag
Return the property bag for this node.
(Inherited from CIPObject.)
Public methodRequestRemoveChild
Called to request permission to remove a child.
(Inherited from CIPObject.)
Public methodServiceErrorStatus
Return error code for a service that's not supported by class nodes.
(Overrides CIPServicesServiceErrorStatus(ServiceCode).)
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.
(Overrides CIPServicesServiceRequest(MessageContext, OutgoingResponseContainer, IncomingRequest, EPATHLogicalPath, ServiceRequestHandler).)
Public methodSetAttributeList
Service SetAttributeList CIP request.
(Inherited from CIPObject.)
Public methodSetAttributesAll
Service SetAttributesAll CIP request.
(Inherited from CIPObject.)
Public methodSetAttributeSingle
Service SetAttributeSingle CIP request.
(Inherited from CIPObject.)
Protected methodSetAttributeValue
Set one attribute to the value read from requestData.
(Inherited from CIPObject.)
Public methodSetInstance
Set the node id.
(Inherited from CIPObject.)
Public methodSetupBus
Setup the bus configuration.
(Inherited from CIPObject.)
Top
See Also