Obtain a set description

saf_describe_set is a function defined in set.c.

Synopsis:

int saf_describe_set(SAF_ParMode pmode, SAF_Set *set, char **name, int *max_topo_dim, SAF_SilRole *role, SAF_ExtendMode *extmode, SAF_TopMode *topmode, int *num_colls, SAF_Cat **cats)

Formal Arguments:

  • pmode: The parallel mode.
  • set: The set to be described.
  • name: [OUT] The returned name of the set. Pass NULL if you do not want this information returned (see *Returned Strings*).
  • max_topo_dim: [OUT] The topological dimension of the set. A NULL pointer can be passed if the caller is not interested in obtaining this information.
  • role: [OUT] The subset inclusion lattice role of the set. A NULL pointer can be passed if the caller is not interested in obtaining this information.
  • extmode: [OUT] Whether the set is extendible or not. A NULL pointer can be passed if the caller is not interested in obtaining this information.
  • topmode: [OUT] Whether the set is a top-level set in the SIL or not
  • num_colls: [OUT] The number of collections currently defined on the set. A NULL pointer can be passed if the caller is not interested in obtaining this information.
  • cats: [OUT] The list of collection categories of the collections defined on the set. A NULL pointer can be passed if the caller is not interested in obtaining this information. cats should point to the NULL pointer if the client wants the library to allocate space, otherwise cats should point to something allocated by the caller. In the latter case, the input value of num_colls indicates the number of handles the cats argument can hold.

Description: This function returns information about a set.

Preconditions:

  • pmode must be valid. (low-cost)
  • set must be a valid set handle. (low-cost)
  • num_colls must be returned if cats is requested. (low-cost)

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:

  • Sets: Introduction for current chapter