NhlRLSetMDArray

NhlRLSetMDArray, NhlRLSetMDIntegerArray, NhlRLSetMDFloatArray, NhlRLSetMDDoubleArray

The Fortran names of these functions are NhlFRLSetMDIntegerArray, NhlFRLSetMDFloatArray NhlFRLSetMDDoubleArray. There is no Fortran binding for NhlRLSetMDArray.

Used to add the given name and value array to the ResList.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlRLSetMDArray(
		int		list_id,
		NhlString	resname,
		NhlPointer	data,
		NhlString	type_element,
		unsigned int	size_element,
		int		num_dimensions,
		int		*len_dimensions
		)

NhlErrorTypes NhlRLSetMDIntegerArray(
		int		list_id,
		NhlString	resname,
		int		*data,
		int		num_dimensions,
		int		*len_dimensions
		)

NhlErrorTypes NhlRLSetMDFloatArray(
		int		list_id,
		NhlString	resname,
		float		*data,
		int		num_dimensions,
		int		*len_dimensions
		)

NhlErrorTypes NhlRLSetMDDoubleArray(
		int		list_id,
		NhlString	resname,
		double		*data,
		int		num_dimensions,
		int		*len_dimensions
		)

Fortran synopsis

      subroutine NhlFRLSetMDIntegerArray(list_id, resname, iarray, 
     +                   num_dimensions, len_dimensions, ierr)
      integer list_id, iarray(*), num_dimensions, len_dimensions, ierr
      character*(*) resname

      subroutine NhlFRLSetMDFloatArray(list_id, resname, rarray,
     +                   num_dimensions, len_dimensions, ierr)
      integer list_id, num_dimensions, len_dimensions, ierr
      real rarray(*)
      character*(*) resname

      subroutine NhlFRLSetMDDoubleArray(list_id, resname, darray,
     +                   num_dimensions, len_dimensions, ierr)
      integer list_id, num_dimensions, len_dimensions, ierr
      double precision darray(*)
      character*(*) resname

Arguments

list_id (input): Id of the ResList to add the name/value pair to.
resname (input): Specifies the resource name to apply the given data to when the list is applied to an HLU object.
data (input, C only): Specifies the array value that will be applied to the corresponding resname when the list is applied to an HLU object.
type_elements (input, C only): Specifies the type of each element of the data array.
size_elements (input, C only): Specifies the size in bytes of each element of the data array.
num_dimensions (input): Specifies the number of dimensions in the data array.
len_dimensions (input): An integer array of length num_dimensions that specifies the length of each dimensions in the data array.
iarray (input, Fortran only): Specifies the multi-dimensioned integer array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
rarray (input, Fortran only): Specifies the multi-dimensioned real array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
darray (input, Fortran only): Specifies the multi-dimensioned double precision array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
ierr (output, Fortran only): Error code.

Types

Type name:		NhlTErrorTypes
Definition:
typedef enum _NhlErrType{
	NhlFATAL	= -4,	/* "FATAL"	*/
	NhlWARNING	= -3,	/* "WARNING"	*/
	NhlINFO		= -2,	/* "INFO"	*/
	NhlNOERROR	= -1	/* "NOERROR"	*/
} NhlErrorTypes;

Description

These functions can only be used on a NhlSETRL ResList. They are used to add name/value pairs to the ResList that will be passed to the NhlCreate or NhlSetValues functions. These functions need to be used when the value part of the name/value pair is an Array.

Return values

The C functions return a value of type NhlErrorTypes, and the Fortran subroutines return the error value in ierr. If they are unable to add the name/value pair to the list, they will return NhlFATAL; otherwise they will return NhlNOERROR.

NhlRLSetMDArray