Get datatype and size for a topological relation¶
saf_get_count_and_type_for_topo_relation
is a function defined in rel.c.
Synopsis:
-
int
saf_get_count_and_type_for_topo_relation
(SAF_ParMode pmode, SAF_Rel *rel, SAF_RelTarget *target, SAF_RelRep *PrepType, size_t *abuf_sz, hid_t *abuf_type, size_t *bbuf_sz, hid_t *bbuf_type)¶
Formal Arguments:
pmode
: The parallel mode.rel
: The relation handle.target
: Targeting information.PrepType
: [OUT
] The mapping representation type (arbitrary, structured, or unstructured). The caller may pass value ofNULL
for this parameter if this value is not desired.abuf_sz
: [OUT
] The number of items that would be placed in the A-buffer by a call to the saf_read_topo_relation function. The caller may pass value ofNULL
for this parameter if this value is not desired.abuf_type
: [OUT
] The type of the items that would be placed in the A-buffer by a call to the saf_read_topo_relation function. The caller may pass value ofNULL
for this parameter if this value is not desired.bbuf_sz
: [OUT
] The number of items that would be placed in theB
-buffer by a call to the saf_read_topo_relation function. The caller may pass value ofNULL
for this parameter if this value is not desired.bbuf_type
: [OUT
] The type of the items that would be placed in theB
-buffer by a call to the saf_read_topo_relation function. The caller may pass value ofNULL
for this parameter if this value is not desired.
Description: This function is used to retrieve the number and type of A-buffer and B
-buffer data items that would be retrieved
by a call to the saf_read_topo_relation function. This function may be used by the caller to determine
the sizes of the buffers needed when pre-allocation is desired or to determine how to traverse the buffer(s)
returned by the saf_read_topo_relation function.
Preconditions:
pmode
must be valid. (low-cost)rel
must be a valid relation handle. (low-cost)- If targeting of storage decomposition is used, the read must be a
SAF__ALL
mode read. (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:
- saf_read_topo_relation: 13.6: Read topological relation data
- Topology Relations: Introduction for current chapter