Declare a collection category

saf_declare_category is a function defined in cat.c.

Synopsis:

SAF_Cat * saf_declare_category(SAF_ParMode pmode, SAF_Db *db, const char *name, SAF_Role *role, int tdim, SAF_Cat *cat)

Formal Arguments:

  • db: The database handle.
  • name: The collection category name.
  • role: Role of collections of this category (see *Collection Roles*).
  • tdim: The maximum topological dimension of the members of collections of this category.
  • cat: [OUT] The returned collection category handle.

Description: This function declares a collection category.

Preconditions:

  • pmode must be valid. (low-cost)
  • db must be a valid database. (low-cost)
  • The database must not be open for read-only access. (no-cost)
  • A name must be supplied for the category. (low-cost)
  • role must be a valid collection role. (low-cost)
  • Topological dimension, tdim, must be positive. (low-cost)

Return Value: The new category handle is returned on success; NULL on failure. If cat is non-null then it will be initialized and used as the return value.

Parallel Notes: This call must be collective across the database communicator.

See Also: