NCL Website header
NCL Home > Documentation > HLUs > Classes

CoordArrTable class

The CoordArrTable class provides a way to describe X/Y coordinate data to the HLU library.


Synopsis

Header file:		ncarg/hlu/CoordArrTable.h
Class name:		coordArrTableClass
Class pointer:		NhlcoordArrTableClass
Fortran class function:	<Not referenceable>
Superclass:		DataItem
Composite classes:	<None>
Note: This object is only available from "C". Fortran programmers should use the CoordArrays object.

Resources

Local resources

+---------------------------------------------------------------+
|			CoordArrTable resource set		|
|---------------------------------------------------------------|
| NAME				TYPE			ACCESS	|
|	CLASS				DEFAULT			|
|===============================================================|
| ctCopyTables			NhlTBoolean		RCSG	|
|       diCopyData                      True                    |
|---------------------------------------------------------------|
| ctXTable			NhlTPointerGenArray	RCSG	|
|       CtXTable                        NULL                    |
|---------------------------------------------------------------|
| ctXTableLengths		NhlTIntegerGenArray	RCSG	|
|       CtXTableLengths                 NULL                    |
|---------------------------------------------------------------|
| ctXTableType			NhlTString		RCSG	|
|       CtXTableType                    NULL                    |
|---------------------------------------------------------------|
| ctXElementSize		NhlTInteger		RCSG	|
|	CtXElementSize			<dynamic>		|
|---------------------------------------------------------------|
| ctXMissingV			NhlTVariable		RCSG	|
|       diMissingValue                  NULL                    |
|---------------------------------------------------------------|
| ctXMaxV			NhlTVariable		RCSG	|
|	CtXMaxV				<dynamic>		|
|---------------------------------------------------------------|
| ctXMinV			NhlTVariable		RCSG	|
|	CtXMinV				<dynamic>		|
|---------------------------------------------------------------|
| ctYTable			NhlTPointerGenArray	RCSG	|
|       CtYTable                        NULL                    |
|---------------------------------------------------------------|
| ctYTableLengths		NhlTIntegerGenArray	RCSG	|
|       CtYTableLengths                 NULL                    |
|---------------------------------------------------------------|
| ctYTableType			NhlTString		RCSG	|
|       CtYTableType                    NULL                    |
|---------------------------------------------------------------|
| ctYElementSize		NhlTInteger		RCSG	|
|	CtYElementSize			<dynamic>		|
|---------------------------------------------------------------|
| ctYMissingV			NhlTVariable		RCSG	|
|       diMissingValue                  NULL                    |
|---------------------------------------------------------------|
| ctYMaxV			NhlTVariable		RCSG	|
|	CtYMaxV				<dynamic>		|
|---------------------------------------------------------------|
| ctYMinV			NhlTVariable		RCSG	|
|	CtYMinV				<dynamic>		|
+---------------------------------------------------------------+

Superclass resources

There are no Superclass resources.


Description

The CoordArrTable object is used to describe X/Y coordinate data to the HLU library. It is usually used in combination with the XyPlot object.

The CoordArrTable object uses two "tables" to do this: the ctXTable and the ctYTable. These "table" resources are actually arrays of arrays. The main array points to something of type **var where type is specified by the ctXTableType and ctYTableType resources. The easiest way to understand this is to think about the table as an array of vectors. Therefore, the "type" for the ctXTable and ctYTable NhlGenArray is NhlPointer, because each element of the NhlGenArray array is actually a pointer to a vector. Each element of each vector is of type ctXTableType, and ctYTableType respectively. The ctXTableType and ctYTableType resources must be set for their respective "Table" resource.

The Min and Max resources are computed if they are not set explicitly. If the ctXTable or ctYTable resources are reset to new values, the Min and Max values are recomputed unless the Min and Max values have been explicitly set by the user. If these resources are ever set, the programmer/user is taking responsibility for updating them if they need to be updated.


Support functions

There are no support functions for the CoordArrTable object, although all the support functions that are available for the DataItem class are available. Additionally, some of the DataComm functions are used with DataItem objects.

See also