Get a description of a state group

saf_describe_state_group is a function defined in state.c.

Synopsis:

int saf_describe_state_group(SAF_ParMode pmode, SAF_StateGrp *state_grp, char **name, SAF_Suite *suite, SAF_StateTmpl *stmpl, SAF_Quantity *quantity, SAF_Unit *unit, hid_t *coord_data_type, int *num_states)

Formal Arguments:

  • pmode: The parallel mode.
  • state_grp: The state group to be described.
  • name: [OUT] Returned name of the state group. Pass NULL if you do not want this value returned.
  • suite: [OUT] Returned suite the state group is associated with.
  • stmpl: [OUT] Returned state template. Pass NULL if you do not want this value returned.
  • quantity: [OUT] The returned quantity associated with the axis of the parametric space. For example, SAF__TIME_QUANTITY.
  • unit: [OUT] The returned units associated with the axis of the parametric space.
  • coord_data_type: [OUT] The returned data type of the coordinates of the parametric space.
  • num_states: [OUT] Returned number of states that have been written to this state group. Pass NULL if you do not want this value returned.

Description: Returns the description of a state group

Return Value: The constant SAF__SUCCESS is returned when this function is successful. Otherwise this function either returns an error number or throws an exception, depending on the value of the library’s error handling property.

See Also:

  • States: Introduction for current chapter