NAME

cxLatRootNew - create a lattice with no data and no coordinates

C SPECIFICATION

#include <cx/DataAccess.h>

cxLattice *cxLatRootNew(long nDim, long dims[])

FORTRAN SPECIFICATION

integer function cxLatRootNew(nDim, dims)
integer nDim, dims(nDim)

PARAMETERS

nDim: Number of lattice dimensions.
dims: Array specifying length in each dimension.

FUNCTION RETURN VALUE

Returns pointer to a lattice with no data or coordinates.

DESCRIPTION

cxLatRootNew creates a cxLattice structure in data memory and returns a pointer to it. The lattice created will have nDim dimensions; the length of each dimension is specified in the array dims. No space for data or coordinates is allocated. See notes below.

Refer to "IRIS Explorer Module Writer's Guide" for more information on the structure of cxLattice and its contents.

Lattice data structures are allocated from a shared memory arena. This shared memory is a limited resource, so it is possible for the memory to be exhausted, causing the allocation routine to fail.

See cxDataManAbortOnError for more details on writing portable module code that copes well with limited memory.

NOTE

Many modules assume that a lattice has data. Modules built with the IRIS Explorer module builder utility (mbuilder(1)) also require that coordinates be present. It is strongly recommended that you lattices be created with both data and coordinates for compatibility. cxLatRootNew, used in conjunction with cxDataNew, cxCoordNew, cxCoordDefaultNew and cxLatPtrSet, allow the lattice, data and coordinates to be created separately.

[ Documentation Home ]