Package de.mid.innovator.srv2api.icw2ac

Interface ANPin

All Superinterfaces:
ACActivityNode, ACObjectNode, ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELMultiplicityAble, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELRedefAble, ELTypedElement, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble
All Known Subinterfaces:
ANActionInputPin, ANInputPin, ANOutputPin, ANValuePin
public interface ANPin extends ELMultiplicityAble, ACObjectNode
A pin is a typed element and multiplicity element that provides values to actions and accept result values from them.
Note:
The interface ANPin describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

  • Method Details

    • isControl

      boolean isControl() throws InoNetException, SrvErrorException
      Informs whether the pins provide the actions with data or just control it when it executes it.
      Throws:
      InoNetException
      SrvErrorException

    • setControl

      void setControl(boolean value) throws InoNetException, SrvErrorException
      Set the value of Attribut IsControl.
      Parameters:
      value - The value to be set.
      Throws:
      InoNetException
      SrvErrorException

    • getCorrespondingPin

      <T extends ANPin> List<T> getCorrespondingPin(Class<T> returnType, ANAction refObj, K_CONTASGN kind, int mode, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException
      Searches for an ANPin assigned to argument refObj that corresponds to the source pin. Properties compared are the kind of the pin (input, output), its name and type. If a argument kind is specified, only pins assigned with this kind will be compared. If argument mode is specified, the kind of the corresponding pin must not equal to the ocl of the incoming pin but to the ocl given in the view interface.
      Parameters:
      returnType - Specifies the type of elements to be returned.
      refObj - A further instance of type ANAction which is used to control the behaviour of the method. (see description above)
      kind - A value of type K_CONTASGN that controls the behaviour of the underlying method. (see description)
      mode - A value of type TInteger that controls the behaviour of the underlying method. (see description)
      behaviourFlags - An optional list of enum values to control the behaviour of the command.
      Throws:
      InoNetException
      SrvErrorException

    • getCorrespondingPin

      <T extends ANPin> List<T> getCorrespondingPin(Class<T> returnType, MMStereotype stereotype, ANAction refObj, K_CONTASGN kind, int mode, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException
      The method calls getCorrespondingPin and filters its return values according to the given stereotype value.
      Parameters:
      returnType - Specifies the type of elements to be returned.
      stereotype - The stereotype used to filter the result list
      refObj - A further instance of type ANAction which is used to control the behaviour of the method. (see description above)
      kind - A value of type K_CONTASGN that controls the behaviour of the underlying method. (see description)
      mode - A value of type TInteger that controls the behaviour of the underlying method. (see description)
      behaviourFlags - An optional list of enum values to control the behaviour of the command.
      Throws:
      InoNetException
      SrvErrorException

    • getParamNode

      List<ACParamNode> getParamNode() throws InoNetException, SrvErrorException
      Finds the ACParamNode corresponding to the ANPin.
      Throws:
      InoNetException
      SrvErrorException

    • getParamNode

      List<ACParamNode> getParamNode(MMStereotype stereotype) throws InoNetException, SrvErrorException
      The method calls getParamNode and filters its return values according to the given stereotype value.
      Parameters:
      stereotype - The stereotype used to filter the result list
      Throws:
      InoNetException
      SrvErrorException

    • getParameter

      CLParameter getParameter(Class<? extends ELObject> kind, int mode) throws InoNetException, SrvErrorException
      Finds the CLParameter that corresponds to the ANPin. If the pin is named, the parameter equally named will be returned, otherwise the ordering of the pin decides. Normally for an ANInputPin, all parameters with In/In-Out direction and for an ANOutputPin all parameters with Out/In-Out/Return direction will be checked. If e.g. an input pin does not correspond to the input direction of the parameter but to the output direction, it is possible to specify a argument kind 'VOCL_ANOutputPin' which will decide the parameter direction. The parameter is normally searched for by name and type. To suppress the type test, argument mode must be set.
      Parameters:
      kind - A value of type K_VOCL that controls the behaviour of the underlying method. (see description)
      mode - A value of type TInteger that controls the behaviour of the underlying method. (see description)
      Throws:
      InoNetException
      SrvErrorException