Package com.piketec.tpt.api.cplatform
Enum CCodeFunctionKind
- java.lang.Object
-
- java.lang.Enum<CCodeFunctionKind>
-
- com.piketec.tpt.api.cplatform.CCodeFunctionKind
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CCodeFunctionKind>
public enum CCodeFunctionKind extends java.lang.Enum<CCodeFunctionKind>
This enumeration defines when scheduled functions will be executed
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CCodeFunctionKind
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CCodeFunctionKind[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
STARTUP
public static final CCodeFunctionKind STARTUP
The function will be executed once after the start of the test frame
-
INITIAL
public static final CCodeFunctionKind INITIAL
The function will be executed once in the first execution cycle
-
PERIODIC
public static final CCodeFunctionKind PERIODIC
The function will be executed cyclic
-
-
Method Detail
-
values
public static CCodeFunctionKind[] 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 (CCodeFunctionKind c : CCodeFunctionKind.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CCodeFunctionKind 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 namejava.lang.NullPointerException
- if the argument is null
-
-