Library Function lick_ckvarnames_fetch

function sctCkRes = lick_ckvarnames_fetch(hSys, sCkType)

Checks all variable parameters and stateflow data found in system <hSys> for adherance to naming conventions. Required naming configuration parameters and libraries exempt from testing are retrieved from the current check configuration.

Check result structure <sctCkRes> always contains member <jExclLibs>, a java.util.HashSet with the libraries excluded from checks. Other members vary depending on check type <sCkType>, see below.

Check type <sCkType> selects the object and rule type to be and might be one out of: - 'pam-len' checks the name length of parameter variables. Check result structure <sctCkRes> will contain additional members: * <nMaxPamNameLen>, the numeric parameter from check configuration defining the maximum number of characters allowed for parameter variables. * <bAllowSctMemPams>, the boolean parameter from check configuration defining wether struct members are allowed or not. If so, the length restriction is applied to all member names and the root name of the structure hierarchy individually. Otherwise the parameter variable is considered an expression and skipped. Wherre expressions are allowed or not might be checked by other rules. * <cTooLong>, a cell array containing parameter variable names found to be too long.

- 'pam-char' checks the names of parameter variables for forbidden characters. Check result structure <sctCkRes> will contain additional members: * <jResWords>, the java.util.HashSet from check configuration defining reserved words that may not be used as a name for parameter variables. * <bAllowSctMemPams>, the boolean parameter from check configuration defining wether struct members are allowed or not. If so, the naming conventions are applied to all member names and the root name of the structure hierarchy individually. Otherwise a respective parameter variable is considered an expression and skipped. Where expressions are allowed or not might be checked by other rules. * <cUscStart>, a cell array containing parameter variable names starting with an underscore or containing a root variable or struct member name, that does so. * <cUscEnd>, a cell array containing parameter variable names ending on an underscore or containing a root variable or struct member name, that does so. * <cUscDbl>, a cell array containing parameter variable names containing multiple consecutive underscores or containing a root variable or struct member name, that does so. * <cEqRes>, a cell array containing parameter variable names equaling a reserved word or containing a root variable or struct member name, that does so.

- 'dat-len' checks the length of stateflow data names. Check result structure <sctCkRes> will contain additional members: * <nMaxDatNameLen>, the numeric parameter from check configuration defining the maximum number of characters allowed for parameter variables. * <cTooLong>, a cell array containing stateflow data names found to be too long.

- 'dat-char' checks stateflow data names for forbidden characters. Check result structure <sctCkRes> will contain additional members: * <jResWords>, the java.util.HashSet from check configuration defining reserved words that may not be used as a stateflow data name. * <cUscStart>, a cell array containing stateflow data names starting with an underscore. * <cUscEnd>, a cell array containing stateflow data names ending on an underscore. * <cUscDbl>, a cell array containing stateflow data names containing multiple consecutive underscores. * <cEqRes>, a cell array containing stateflow data names equaling a reserved word.