Package com.piketec.tpt.api.cplatform

Enum FunctionConnectionType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FunctionConnectionType>
    public enum FunctionConnectionType
extends java.lang.Enum<FunctionConnectionType>
    Setting to connect a function in the c-code to TPT
    Author:
    Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ARGUMENTS_AS_CHANNELS
      Stub the function to connect the arguments and the return value to TPT channels
      CLIENT_FUNCTION
      Create a TPT client function to be called from a steplist.
      EMPTYSTUB
      "Stub the function returning zeros.
      IGNORE
      Do nothing concerning this function
      SCHEDULE
      Schedule the function with TPT.
      SERVER_FUNCTION
      Stub the function to call a TPT server function.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FunctionConnectionType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FunctionConnectionType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SCHEDULE

        public static final FunctionConnectionType SCHEDULE
        Schedule the function with TPT. Only supported for functions that are implemented in the SUT code.

      • CLIENT_FUNCTION

        public static final FunctionConnectionType CLIENT_FUNCTION
        Create a TPT client function to be called from a steplist. Only supported for functions that are implemented in the SUT code.

      • SERVER_FUNCTION

        public static final FunctionConnectionType SERVER_FUNCTION
        Stub the function to call a TPT server function. Only supported for functions that are not implemented in the SUT-code.

      • ARGUMENTS_AS_CHANNELS

        public static final FunctionConnectionType ARGUMENTS_AS_CHANNELS
        Stub the function to connect the arguments and the return value to TPT channels

      • EMPTYSTUB

        public static final FunctionConnectionType EMPTYSTUB
        "Stub the function returning zeros. Only supported for functions that are not implemented in the SUT-code.

    • Method Detail

      • values

        public static FunctionConnectionType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FunctionConnectionType c : FunctionConnectionType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FunctionConnectionType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null