B.1.5 CADIParameterInfo_t

The CADIParameterInfo_t and CADIParameterValue_t structs configure component parameters.

struct CADIParameterInfo_t
{
public: // methods
    CADIParameterInfo_t(uint32_t id=0,
            const char *name_par="",
            CADIValueDataType_t dataType=CADI_PARAM_INVALID,
            const char *description_par = "",
            uint32_t isRunTime = 0, 
            int64_t minValue = 0,
            int64_t maxValue = 0, 
            int64_t defaultValue = 0,
            const char *defaultString_par = "") :
          id(id), dataType(dataType),
          isRunTime(isRunTime),
          minValue(minValue),
          maxValue(maxValue),
          defaultValue(defaultValue)
          {
            AssignString(name, name_par, CADI_NAME_SIZE);
            AssignString(description, description_par, CADI_DESCRIPTION_SIZE);
            AssignString(defaultString, defaultString_par,
            CADI_DESCRIPTION_SIZE);
          }
public: // data
        uint32_t   id;        
        char  name[CADI_NAME_SIZE];   
        CADIValueDataType_t dataType;  
        char  description[CADI_DESCRIPTION_SIZE];  
        uint32_t   isRunTime;          
        int64_t   maxValue;    
        int64_t   defaultValue;        
        char  defaultString[CADI_DESCRIPTION_SIZE]; 
};
id
is for identification.
name
is the name of the parameter.
dataType
is the data type for interpretation purposes of the debugger.
description
is the parameter description.
isRunTime
if 0, the parameter is instantiation-time only. If 1, the parameter can be changed at runtime.
minValue
is the minimum admissible value.
maxValue
is the maximum admissible value.
defaultValue
if the type is bool or int, the default value.
defaultString
if the type is CADI_PARAM_STRING, the default string.
Non-ConfidentialPDF file icon PDF versionARM 100963_0200_00_en
Copyright © 2014–2017 ARM Limited or its affiliates. All rights reserved.