PMTM Constants

PMTM Constants

Fortran Type	C Type	Name	Description
integer	PMTM_instance_t	PMTM_DEFAULT_INSTANCE	The default instance handle which can be used whenever an instance is required in a PMTM routine.
integer	PMTM_timer_group_t	PMTM_DEFAULT_GROUP	The default timer group handle which can be used whenever a timer group is required in a PMTM routine.

• | PMTM_timer_t | PMTM_NULL_TIMER | A value to which no valid timer will set. Useful to set as an initial value for timers so that if they have not been initialised before they are used PMTM will issue an error.
  integer | PMTM_timer_type_t | PMTM_TIMER_NONE | Used in the [PMTM_create_timer] routine. This specifies to output no statistics for the given timer.
  integer | PMTM_timer_type_t | PMTM_TIMER_MAX | Used in the [PMTM_create_timer] routine. This specifies to output maximum times across all ranks for the given timer.
  integer | PMTM_timer_type_t | PMTM_TIMER_MIN | Used in the [PMTM_create_timer] routine. This specifies to output minimum times across all ranks for the given timer.
  integer | PMTM_timer_type_t | PMTM_TIMER_AVG | Used in the [PMTM_create_timer] routine. This specifies to output average times across all ranks for the given timer.
  integer | PMTM_timer_type_t | PMTM_TIMER_ALL | Used in the [PMTM_create_timer] routine. This specifies to output average, maximum and minimum times across all ranks for the given timer.
  integer | PMTM_output_type_t | PMTM_OUTPUT_ALWAYS | Use in the [PMTM_parameter_output] routine. This specifies to output the parameter on every call to this routine.
  integer | PMTM_output_type_t | PMTM_OUTPUT_ON_CHANGE | Use in the [PMTM_parameter_output] routine. This specifies to output the parameter whenever the value of the parameter is different to the last time the routine was called.
  integer | PMTM_output_type_t | PMTM_OUTPUT_ONCE | Use in the [PMTM_parameter_output] routine. This specifies to output the parameter on the first call to the routine and then to ignore all later calls with the same parameter name.
  integer | int | PMTM_NO_MAX | Use in the [PMTM_set_sample_mode] routine to specify that the given timer should have no maximum number of samples.
  integer | int | PMTM_DEFAULT_FREQ | Use in the [PMTM_set_sample_mode] routine to specify that the given timer should sample with the default sample frequency (default: sampling on each timer routine call).
  integer | int | PMTM_DEFAULT_MAX | Use in the [PMTM_set_sample_mode] routine to specify that the given timer should have the default number of maximum samples (default: no maximum number of samples).
• | PMTM_BOOL | PMTM_TRUE | True value used in PMTM.
• | PMTM_BOOL | PMTM_FALSE | False value used in PMTM.