Metrics: cs_metric.h

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.0p0 Hot Tips

CONFIDENTIAL

CodeSecure Inc

Metrics: cs_metric.h

Provides types and methods for metric granularities and metric computation functions.

Links
Defines
Types
Functions
Function Descriptions

Defines

#define CS_METRIC_H
#define CSMETRIC_GRANULARITY_COUNT	6

Types

typedef cs_metric_granularity

Definition	typedef enum cs_metric_granularity cs_metric_granularity
Notes	The possible granularities of a metric. Used by csonar_metric_get_class() csonar_metric_get_granularity() csonar_metric_class_iter_first() cs_metric_granularity_from_string() cs_metric_granularity_name()

Definition

typedef enum cs_metric_granularity cs_metric_granularity

Notes

The possible granularities of a metric.

Used by

typedef cs_metric_calc_analysis_fn_t

Definition	typedef cs_result(* cs_metric_calc_analysis_fn_t)(double , const void )
Notes	Function pointer type to use when defining a new analysis-granularity metric. Used by csonar_metric_create_class_analysis().

typedef cs_metric_calc_directory_fn_t

Definition	typedef cs_result(* cs_metric_calc_directory_fn_t)(cs_directory, double , const void )
Notes	Function pointer type to use when defining a new directory-granularity metric. Used by csonar_metric_create_class_directory().

typedef cs_metric_calc_compunit_fn_t

Definition	typedef cs_result(* cs_metric_calc_compunit_fn_t)(cs_uid, double , const void )
Notes	Function pointer type to use when defining a new compilation-unit-granularity metric. Used by csonar_metric_create_class_compunit().

typedef cs_metric_calc_file_fn_t

Definition	typedef cs_result(* cs_metric_calc_file_fn_t)(cs_sf, double , const void )
Notes	Function pointer type to use when defining a new file-granularity metric. Used by csonar_metric_create_class_file().

typedef cs_metric_calc_procedure_fn_t

Definition	typedef cs_result(* cs_metric_calc_procedure_fn_t)(cs_pdg, double , const void )
Notes	Function pointer type to use when defining a new procedure-granularity metric. csonar_metric_create_class_procedure().

enum cs_metric_granularity

Definition

typedef enum {

csmetric_invalid = = 0,
csmetric_procedure = = 100,
csmetric_file = = 200,
csmetric_compunit = = 300,
csmetric_directory = = 350,
csmetric_analysis = = 400

} cs_metric_granularity

Notes

The possible granularities of a metric.

Used by

Functions

cs_metric_granularity	cs_metric_granularity_from_string ( cs_const_string gran_str ) Convert the string representation of a metric granularity into a cs_metric_granularity.
cs_const_string	cs_metric_granularity_name ( cs_metric_granularity gran ) Get the string representation of a cs_metric_granularity.