NCL Website header
NCL Home > Documentation > HLUs > Classes

ImageWorkstation class

The ImageWorkstation object manages communication with an experimental Workstation device intended for generating image-based output formats (e.g., PNG).

Synopsis

Header file:		ncarg/hlu/CairoWorkstation.h
Class name:		imageWorkstationClass
Class pointer:		NhlcairoImageWorkstationClass
Fortran class function:	NHLFCAIROIMAGEWORKSTATIONCLASS
Superclass:		Workstation
Composite classes:	<None>

Class-defined types

Type name:		NhlTCairoFormat
Definition:		typedef enum {
				NhlCPS		= 0,	/* "Cairo-based postscript" */
                                NhlCPNG         = 1,    /* "Cairo-based PNG"        */
                                NhlCPDF         = 2,    /* "Cairo-based PDF"        */
			} NhlCairoFormat;

Resources

Local resources

+---------------------------------------------------------------+
|			CairoImageWorkstation resource set	|
|---------------------------------------------------------------|
| NAME				TYPE			ACCESS	|
|	CLASS				DEFAULT			|
|===============================================================|
| wkFormat			NhlTFormat		RCG	|
|	WkFormat			NhlCPNG			|
|---------------------------------------------------------------|
| wkFileName			NhlTString		RCG	|
|	WkFileName			<dynamic>		|
|---------------------------------------------------------------|
| wkWidth			NhlTInteger		RCG	|
|	WWidth				1024			|
|---------------------------------------------------------------|
| wkHeight			NhlTInteger		RCG	|
|	WkHeight			1024			|
|---------------------------------------------------------------|

Composite resources

The ImageWorkstation object class has no composite class members.

Superclass resources

You can set all resources defined by the superclasses of the ImageWorkstation object class, including:


Description

The ImageWorkstation object is derived from the Workstation class and thus inherits all of the color map management and control functions associated with the Workstation class.


Support functions

The ImageWorkstation object does not define any support functions; it inherits all the support functions available to its superclass.

Status

Experimental; currently only PNG format is supported. New in NCL 5.2.0.

See also