The AIDA_tstParam structure contains information about a specific parameter of an AIDA component.
typedef struct {
const xchar *xsParamName;
AIDA_tenParamType enParamType;
AIDA_tenParamAttrib enParamAttrib;
byte bParamFlags;
byte bCacheInfo;
byte bReserved[1];
byte bVisualization;
AIDA_tunParamVal unParamVal;
AIDA_tstValListEntry *pstParamValList;
} AIDA_tstParam;
'\0'
character and are finally terminated by a double '\0'
character, e. g.
"Bitrate\000Unit: [ms]\0"
'\0'
character is being added by the compiler). At the moment two
fields are defined: The first field contains the name of the parameter, the second field if present contains a comment.AIDA_nParamVariableFlags
AIDA_nParamStaticFlags
AIDA_nParamVariableFlags can be used to get the changeable flags.
Possible values for these are:AIDA_nParamChangeable
AIDA_nParamDontSave
AIDA_nParamDontEdit
AIDA_nParamChangeable is set when the given parameter currently may be changed. The status of this flag depends on the status of the stack and gives the application an easy means to check whether a parameter may be changed without knowing the status of the whole stack.
AIDA_nParamDontSave is set when the given parameter is not to be saved by AIDA_boSaveStack. This flag may be set when the given parameter is controlled by another component that is a member of the stack.
AIDA_nParamDontEdit is set when the given parameter shall not be modified by the application. This flag may be set when the given parameter is configured by another component that is a member of the stack.
AIDA_nParamAttachable
AIDA_nParamAttachable is set when the given parameter can be used in parameter attachments (see AIDA_boAttachParam for details).
AIDA_nParamDirty
AIDA_nParamListDirty
AIDA_nStackDirty
AIDA_nParamDirty will be set whenever a parameter has been changed.
AIDA_nParamListDirty will be set for the first parameter of a parameter list whenever the list has been changed (e. g. parameters have been added or removed).
AIDA_nStackDirty will be set for the first parameter of a parameter list in every stack level whenever the stack structure has been changed (e. g. components have been added or removed).
These flags are used by any kind of network component to decide which parts of the stack handle structure has to be retrieved to get the local copy synchronized with the remote stack handle structure.
AIDA_nPreferNone
AIDA_nPreferDec
AIDA_nPreferHex
AIDA_nPreferBin
AIDA_nPreferNone is set when there are no preferred visualization modes for the given parameter (normally set for AIDA_nenString and AIDA_nenReal.
AIDA_nPreferDec is set when the given parameter shall be shown as decimal number.
AIDA_nPreferHex is set when the given parameter shall be shown as hexadecimal number.
AIDA_nPreferBin is set when the given parameter shall be shown as bitfield.
AIDA Overview, AIDA Structures And Datatypes, AIDA_tstReplacementTableEntry, AIDA_tenParamType, AIDA_tenParamAttrib, AIDA_tenValListEntryType, AIDA_tunParamVal, AIDA_tstValListEntry