SDK. Access to Min / Max Values and additional attribues

Baur_CMO-SYS · Apr 23rd 2019

Hello,

we are using the SDK sucessfully, but are missing some informations in order to achieve the full functionality like using MicroDisplay.

For example to read the Min / Max values for a parameter to be changed, we would like to use the function
Fg_getParameterProperty(). From the header files we assume that we can read out the IDs for there values (i.e PROP_ID_MIN_ID gives back a hex coded string with 6 digits which might be the ID to read the Min value in advance). Unfortunately the subequent read of the value to that ID does not result in the expected value and the string is not null-terminated after the '0x123456' character.
Is there an additional information about that we missed?
Also it would be helpful to get access to additional parameters like R/W access attributes and comments to parameters like MicroDisplay shows up.

Thanks, Holger

Johannes Trein · May 2nd 2019

Hello Holger,

Did you check the SDK example in "%sisodir5%\SDKExamplesNew\examples\fglib\Parametrization\FgParameterIteration\FgParameterIterationExample.cpp" ?

Maybe you'll find your answer there.

Johannes

Baur_CMO-SYS · May 5th 2019

Hello Johannes.

Thanks for that hint, i did include an older fgrab_prototyp.h file from a recend project. That only had the PROP_ID_MIN_ID etc. but not the PROP_ID_MIN and so on.

Holger

B.Ru · May 6th 2019

If you have a look into the example source for the parameter iteration you can find the code below concerning the range details like Min,Max,Step for the value you would like to change.

C: %SISODIR5%\SDKExamplesNew\examples\fglib\Parametrization\FgParameterIteration\FgParameterIterationExample.cpp

    template<typename TYPE>
    void printNumberValueInformation(Fg_Struct* fg, const int32_t parameterId){
        int32_t status = FG_OK;
        const int32_t charArrSize = 255;
        int32_t dataSize = charArrSize;
        std::unique_ptr<char[]> dataTypeCharArr(new char[charArrSize]);

        dataSize = charArrSize;
        status = Fg_getParameterProperty(fg, 
            parameterId, 
            PROP_ID_MIN, 
            dataTypeCharArr.get(), 
            &dataSize);
        if(status != FG_OK)
            mLog->printError(Fg_getLastErrorDescription(fg));
        else{
            TYPE minValue = parseNumber<TYPE>(dataTypeCharArr.get());
            mLog->printKeyVal("Min Value:", minValue);
        }

        dataSize = charArrSize;
        status = Fg_getParameterProperty(fg, 
            parameterId, 
            PROP_ID_MAX, 
            dataTypeCharArr.get(), 
            &dataSize);
        if(status != FG_OK)
            mLog->printError(Fg_getLastErrorDescription(fg));
        else{
            TYPE maxValue = parseNumber<TYPE>(dataTypeCharArr.get());
            mLog->printKeyVal("Max Value:", maxValue);
        }

        dataSize = charArrSize;
        status = Fg_getParameterProperty(fg, 
            parameterId, 
            PROP_ID_STEP, 
            dataTypeCharArr.get(), 
            &dataSize);
        if(status != FG_OK)
            mLog->printError(Fg_getLastErrorDescription(fg));
        else{
            TYPE stepSize = parseNumber<TYPE>(dataTypeCharArr.get());
            mLog->printKeyVal("Step size:", stepSize);
        }

        dataSize = charArrSize;
        status = Fg_getParameterProperty(fg, 
            parameterId, 
            PROP_ID_VALUE, 
            dataTypeCharArr.get(), 
            &dataSize);
        if(status != FG_OK)
            mLog->printError(Fg_getLastErrorDescription(fg));
        else{
            TYPE paramValue = parseNumber<TYPE>(dataTypeCharArr.get());
            mLog->printKeyVal("Value: ", paramValue);
        }
    }

Display More

Please use our most current runtime version and the corresponding include files.

Mixing different versions may lead to unwanted side-effects that potentially make debugging a pain.

B.Ru · May 6th 2019

As mentioned in our runtime help on Fg_getParameterProperty ...

The required virtual parameter IDs are defined for RT 5.7.0 release as see below:

C: %SISODIR5%\include\fgrab_define.h

/**
 * \brief definitions for querying information about a certain field
 */
enum FgProperty {
    PROP_ID_VALUE         = 0,  /**< request the current value of a parameter, information,.. */
    PROP_ID_DATATYPE      = 1,  /**< request the data type of a parameter, information, */
    PROP_ID_NAME          = 2,  /**< request the symbolic name of a parameter, information, */
    PROP_ID_PARAMETERNAME = 3,  /**< request the Name for Software access */
    PROP_ID_VALUELLEN     = 4,  /**< request the current length of data */
    PROP_ID_ACCESS_ID     = 5,  /**< request the parameter id for access parameter*/
    PROP_ID_MIN_ID        = 6,  /**< request the parameter id for min parameter*/
    PROP_ID_MAX_ID        = 7,  /**< request the parameter id for max parameter*/
    PROP_ID_STEP_ID       = 8,  /**< request the parameter id for step parameter*/
    PROP_ID_ACCESS        = 9,  /**< request the parameter id for access parameter*/
    PROP_ID_MIN           = 10, /**< request the min value*/
    PROP_ID_MAX           = 11, /**< request the max value*/
    PROP_ID_STEP          = 12, /**< request the value for step size*/
    PROP_ID_IS_ENUM       = 13, /**< request if the int parameter is an enumeration; the value returned as string is the length of the buffer needed for the enum values; 0 means it's not an enum*/
    PROP_ID_ENUM_VALUES   = 14, /**< request the enumeration values*/
    PROP_ID_FIELD_SIZE    = 15, /**< request the size of a field parameter*/
};

Display More

SDK. Access to Min / Max Values and additional attribues

Share

Tags