Skip to main content
Open topic with navigation

sysSetVariableFloatArray

CAPL Functions » System Variables » sysSetVariableFloatArray Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

Function Syntax

long sysSetVariableFloatArray(char namespace[], char variable[], float values[], long arraySize); // form 1
long sysSetVariableFloatArray(SysVarName, float values[], long arraySize); // form 2

Description

Sets the value of a variable of the float[] type. The call will only succeed if the array size given as parameter is equal to the actual array size of the system variable (you cannot change that size dynamically). The current values of the system variable will then be set to the elements in the values array in the range from 0 to arraySize. Never give as parameter an array size which is larger than real size of the values array, this would lead to unpredictable behavior. Note
  • Direct access to values from system variables. An access to the whole array is with this variant not possible.
  • The function can also be used for specific elements of a system variable of type struct or generic array. For this, add the element to the name of the variable. If you directly give the element name to the function instead of using strings, precede the name by sysvarMember:: instead of sysvar::. Example: sysvarMember::SomeNamespace::SomeStructVariable.SomeArrayMember[0]

Parameters

  • namespace: Name of the namespace.
  • variable: Name of the variable.
  • values: New values of the variable.
  • arraySize: Number of values in the array.
  • SysVarName: Name of the fully qualified name of the system variable, including all namespaces, separated by ”::”. The name must be preceded by “sysVar::”.

Return Values

  • 0: no error, function successful
  • 1: namespace was not found or second try to define the same namespace
  • 2: variable was not found or second try to define the same variable
  • 3: no writing right for the namespace available
  • 4: the variable has no suitable type for the function

Example

Example 1
float fVarArr[10];
...
sysSetVariableFloatArray(sysvar::MyNamespace::FloatArrayVar, fVarArr, elcount(fVarArr));
Example 2 This example shows the use of system variable types as a return value of functions and as a local variable. The user-defined CAPL function getSysVarFloatArray returns any system variable of type FloatArray. The function is therefore defined with the system variable type sysvarFloatArray as the return value. The system variable sv1 (defined with system variable type FloatArray) represents any system variable depending on the counter of the getSysVarFloatArray function. The value of a system variable is set with the CAPL function sysSetVariableFloatArray. The value of the system variable is get with the CAPL function sysGetVariableFloatArray and output in the Write Window. Note You must define the system variables FMW1::KeyFloatArray, DCM::SpeedSignalFloatArray, and Engine::EngineFloatArray in the System Variables Configuration dialog first.
on key 'g'
{
  sysvarFloatArray * sv1;
  float fVarArr [5] = {7.3, 7.3, 7.3, 7.3, 7.3};
  sv1 = getSysVarFloatArray(0);
  write("Variable is %s%s, Value is %2.1lf", sv1.name, "[0]", @sv1[0]);
  sysSetVariableFloatArray(sv1, fVarArr, elcount(fVarArr));
  write("Variable is %s%s, Value is: %2.1lf", sv1.name, "[0]", @sv1[0]);
  sv1 = getSysVarFloatArray(1);
  write("Variable is %s%s, Valgue is %2.1lf", sv1.name, "[0]", @sv1[0]);
  sv1 = getSysVarFloatArray(2);
  sysGetVariableFloatArray(sv1, fVarArr, elcount(fVarArr));
  write("Variable is %s%s, Value is %2.1lf", sv1.name, "[0]", fVarArr[0]);
}

sysvarFloatArray * getSysVarFloatArray(int gKey)
{
  switch (gKey)
  {
    case 0:
      return sysvar::FMW1::KeyFloatArray;
    case 1:
      return sysvar::DCM::SpeedSignalFloatArray;
    default:
      return sysvar::Engine::EngineFloatArray;
  }
}
sysGetVariableFloatArray