Get a description of a subset relation

saf_describe_subset_relation is a function defined in rel.c.

Synopsis:

int saf_describe_subset_relation(SAF_ParMode pmode, SAF_Rel *rel, SAF_Set *sup, SAF_Set *sub, SAF_Cat *sup_cat, SAF_Cat *sub_cat, SAF_BoundMode *sbmode, SAF_BoundMode *cbmode, SAF_RelRep *srtype, hid_t *data_type)

Formal Arguments:

  • pmode: The parallel mode.
  • rel: The relation handle.
  • sup: [OUT] The superset. Pass NULL if you do not want this value returned.
  • sub: [OUT] The subset. Pass NULL if you do not want this value returned.
  • sup_cat: [OUT] The collection category on the sup set upon which the subset relation is defined. Note that collections of this category must have already been defined on sup. Otherwise, an error is generated. Note that the four args sup_cat, sub_cat, sbmode, and cbmode are typically passed using one of the macros described in the saf_declare_subset_relation call, SAF__COMMON, SAF__BOUNDARY, SAF__EMBEDBND or SAF__GENERAL. Pass NULL if you do not want this value returned.
  • sub_cat: [OUT] The collection category on the sub set upon which the subset relation is defined. Again, pass NULL if you do not want this value returned.
  • sbmode: [OUT] Indicates whether sub is the boundary of sup. A value of SAF__BOUNDARY_TRUE, indicates that the sub is a boundary of sup. A value of SAF__BOUNDARY_FALSE indicates sub is not a boundary of sup. Pass NULL if you do not want this value returned.
  • cbmode: [OUT] Indicates whether members of collection on sub are on the boundaries of members of the collection on sup. A value of SAF__BOUNDARY_TRUE indicates they are. A value of SAF__BOUNDARY_FALSE indicates they are not. Pass NULL if you do not want this value returned.
  • srtype: [OUT] The representation specification. Pass NULL if you do not want this handle returned. See saf_declare_subset_relation for the meaning of values of this argument.
  • data_type: [OUT] The data-type of the data stored with the relation. Pass NULL if you do not want this value returned.

Description: Returns information about a subset relation.

Preconditions:

  • pmode must be valid. (low-cost)
  • The rel argument must be a valid handle. (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: