CAPLfunctionsSystemVariablesOverview

Open topic with navigation

CAPL Functions » System Variables CAPL Functions

System Variables CAPL Functions

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

System Variables

These CAPL functions are supported by Windows and Linux. The functionality under Linux has not been fully tested yet.

---

ON THIS PAGE:

• Define Variables
• General Functions
• Return Data of a Variable
• Set the Value of a Variable
• Structs of System Variables
• Variable Filters

Define Variables

• sysDefineVariableData: Defines a variable of the data type.
• sysDefineVariableFloat: Defines a variable of the float type.
• sysDefineVariableFloatArray: Defines a variable of the float[] type.
• sysDefineVariableLong: Defines a variable of the long type.
• sysDefineVariableLongArray: Defines a variable of the long[] type.
• sysDefineVariableLongLong: Defines a variable of the Int64 type.
• sysDefineVariableString: Defines a variable of the String (char[]) type.

General Functions

• sysDefineNamespace: Defines a namespace.
• sysUndefineNamespace: Deletes a namespace.
• sysUndefineVariable: Deletes a variable.

Return Data of a Variable

• SysGetOrigTimeNS: Returns the original time stamp of the last update to the variable value.
• sysGetVariableArrayLength: Returns the length of an array system variable.
• sysGetVariableArraySize: Returns the current array size of a system variable (element) of a generic array type.
• sysGetVariableData: Returns the value of a variable of the data type.
• sysGetVariableDescriptionForValue: Retrieves a description for a value of a system variable of type long or long array.
• sysGetVariableDWord: Returns the value of a variable of the word type.
• sysGetVariableFloat: Returns the value of a variable of the float type.
• sysGetVariableFloatArray: Returns the value of a variable of the float[] type.
• sysGetVariableLong: Returns the value of a variable of the long type.
• sysGetVariableLongArray: Returns the value of a variable of the long [] type.
• sysGetVariableLongLong: Returns the value of a variable of the int64.
• sysGetVariableMax: Retrieves the maximum of a variable.
• sysGetVariableMin: Retrieves the minimum of a variable.
• sysGetVariableQWord: Returns the value of a variable of the qword type.
• sysGetVariableString: Returns the value of a variable of the string (char[]) type.
• sysGetVariableSVType: Gets the type of a system variable encoded as a long integer.
• sysGetVariableTimeNS: Returns the time stamp of the last update to the variable value.
• sysGetVariableValueForDescription: Retrieves the value for a value description of a system variable of type long or long array.
• sysIsVariableTypeSigned: Returns whether the data type of a system variable is signed.

Set the Value of a Variable

• sysResetValue: Resets a system variable to its initial value.
• sysResetValues: Resets all system variables in a namespace to their initial values.
• sysSetAnalysisOnlyVariable: Defines whether the variable shall be used only in the analysis area.
• sysSetVariableAsync: Assigns a value to a system variable.
• SysSetVariableArraySize: Sets the current array size of a system variable (element) of a generic array type.
• sysSetVariableData: Sets the value of a variable of the data type.
• sysSetVariableDescriptionForValue: Sets a description for a particular value of a system variable of type long or long array.
• sysSetVariableDWord: Sets the value of a variable of the dword type.
• sysSetVariableFloat: Sets the value of a variable of the float type.
• sysSetVariableFloatArray: Sets the value of a variable of the float[] type.
• sysSetVariableLong: Sets the value of a variable of the long type.
• sysSetVariableLongArray: Sets the value of a variable of the long[] type.
• sysSetVariableLongLong: Sets the value of a variable of the int64.
• sysSetVariableQWord: Sets the value of a variable of the qword type.
• sysSetVariableString: Sets the value of a variable of the string (char[]) type.

Structs of System Variables

• sysBeginVariableStructUpdate: Starts the update of several elements of a system variable of type struct or generic array.
• sysEndVariableStructUpdate: Ends the update of several elements of a system variable of type struct or generic array.
• sysGetVariableMemberPhys: Retrieves the physical value of a specific element of a variable of type struct or generic array.
• sysSetVariableMemberPhys: Sets the physical value of a specific element of a variable of type struct or generic array.

Variable Filters

• sysCreateVariableFilter: Creates a new variable filter behind the node calling the function.
• sysFilterAddNamespace: Adds a namespace to the variable filter.
• sysFilterAddVariable: Adds a variable a variable filter.
• sysFilterRemoveNamespace: Removes a namespace from the variable filter.
• sysFilterRemoveVariable: Removes a variable from a variable filter.
• sysSetVariableFilterActive: Activates or deactivates a variable filter.

System Variables • Direct Access to Values from System Variables