Details on the properties of the SPELFunc object

  • Name Property
    This property sets a particular name that is assigned to force guide object.
    When creating the SPELFunc object, name is assigned automatically. Automatically assigned name is added a number after SPELFunc (e.g. SPELFunc01).
    You can change the name. Set up 16 characters at the maximum. Please use alphanumeric characters and underscores [_]. Note: The initial character cannot be a numeric character.
  • Description Property
    This property sets descriptions about force guide objects. You can set the character string up to 255 characters.
  • Enabled Property
    This property sets whether to enable force guide objects.
    When specifying True, the force guide object is executed.
    When specifying False, execute the next force guide object without executing the Decision object or any force guide objects branching from it.
    Use this property when you want to save the force guide sequence temporary or try with different parameters by copying the force guide object during the force guide sequence creation.
    Value
    Description
    True Enable a force guide object.
    False Disable a force guide object.
    Default: True
  • StepID Property
    This property sets StepID during the execution of the force guide objects. It is only used when AutoStepID is False.
    Value
    Minimum Value 0
    Maximum value 32767
    Default: Automatically set according to the numbers of the force guide sequence and the force guide object.
  • AbortSeqOnFail Property
    This property sets operations when force guide object fails.
    When True is specified: If the force guide object fails, the program ends the force guide sequence and proceeds to the next SPEL statement.
    When specifying False: If force guide object fails, the program proceeds to the next force guide object without ending the force guide sequence.
    Use this property when you want to continue the force guide sequence (e.g. the recovery processes are included in the force guide sequence when the force guide object fails.)
    Value
    Description
    True Abort the force guide sequence when the force guide object fails.
    False Start the next force guide sequence when the force guide object fails.
    Default: True
  • FuncName Property
    Set a name of SPELFunc name to be executed.
    A function to be specified by SPELFunc object must have a string type variable for an argument and the return value type must be Boolean.
    SPELFunc object is failed when the return value of the SPELFunc to be specified is False.
    The following is an example of the available SPELFunc.

    Function MyFunc(ObjectName$ As String) As Boolean
      MyFunc = True
    Fend