Package com.automation_pros.odva.cip.core

Class CipInstance

    • Field Detail

      • attr_all

        protected int[] attr_all

    • Constructor Detail

      • CipInstance

        protected CipInstance​(InstanceHolder parent,
                      java.lang.String name)

    • Method Detail

      • number

        public int number()

      • compareTo

        public int compareTo​(CipInstance inst)
        Specified by:
        compareTo in interface java.lang.Comparable<CipInstance>

      • service

        public void service​(CipObject appContext,
                    CipRequest request,
                    int nesting)
        Description copied from class: CipObject

        Execute a CIP service on the object, using the request supplied. Supply a reply to the request and/or throw an appropriate CipException. Replies are not required before this routine returns.

        Direct service() calls MUST NOT BLOCK. Any operation that will take any significant time must be delegated to an executor. "Significant" may vary by application, but typically would be in the fractional millisecond range.

        Specified by:
        service in interface AttributeHolder
        Overrides:
        service in class CipObject
        Parameters:
        appContext - Root object for application path lookups. Generally a Mirrored Device from a port context.
        request - What to do and where to reply. Services to be handled by child objects are to be passed to their service() method with nesting+1.
        nesting - How many leading path segments items to skip when processing this request. Avoids copying the balance of an application path into a new request when passing a request to a child object.

      • getEPathImpl

        public CipPath getEPathImpl()
        Description copied from class: CipTree
        Retrieve the application path that leads to this object starting at the root (no parent). Will be called by getEPath() and the result cached by default.

        Root elements must override this to return an empty CipPath.

        Overrides:
        getEPathImpl in class CipTree
        Returns:

      • getAttribute

        public CipAttribute getAttribute​(int inst)
        Description copied from interface: AttributeHolder
        Classes and class instances implement this interface, which indicates that this object contains attributes that can be retrieved by number.
        Specified by:
        getAttribute in interface AttributeHolder
        Parameters:
        inst - The attribute number to retrieve, 1-65535.
        Returns:
        The attribute object or null if it doesn't exist

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class CipObject

      • setParent

        public CipInstance setParent​(CipTree parent)
        Description copied from class: CipTree
        Set or remove the parent of this CipTree, possibly removing this object from a previous parent before assigning to the new parent. Override this method if additional housekeeping is required when assigning or removing parents.
        Overrides:
        setParent in class CipObject
        Parameters:
        parent - The new parent of this object.
        Returns:
        The object replaced by this object in the parent, if any.

      • isPrivate

        public boolean isPrivate()