NCL Home > Documentation > HLUs > Classes

DocumentWorkstation class

The DocumentWorkstation object manages communication with an experimental Workstation device that is designed to generate document-based formats, such as postscript or PDF.

Available in version 5.2.0 and later.

Synopsis

Header file:		ncarg/hlu/CairoWorkstation.h
Class name:		documentWorkstationClass
Class pointer:		NhlcairoPSPDFWorkstationClass
Fortran class function:	NHLFCAIROPSPDFWORKSTATIONCLASS
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

+---------------------------------------------------------------+
|			DocumentWorkstation resource set	|
|---------------------------------------------------------------|
| NAME				TYPE			ACCESS	|
|	CLASS				DEFAULT			|
|===============================================================|
| wkFormat			NhlTFormat		RCG	|
|	WkFormat			NhlCPS			|
|---------------------------------------------------------------|
| wkFileName			NhlTString		RCG	|
|	WkFileName			<dynamic>		|
|---------------------------------------------------------------|
| wkPDFResolution		NhlTInteger		RCG	|
|	WkPDFResolution			1800			|
|---------------------------------------------------------------|
| wkPaperSize      		NhlTString		RCG	|
|	WkPaperSize			"letter"		|
|---------------------------------------------------------------|
| wkPaperWidthF    		NhlTFloat		RCG	|
|	WkPaperWidthF			<dynamic>		|
|---------------------------------------------------------------|
| wkPaperHeightF		NhlTFloat		RCG	|
|	WkPaperHeightF			<dynamic>		|
+---------------------------------------------------------------+

Composite resources

The DocumentWorkstation object class has no composite class members.

Superclass resources

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

Workstation resources

Description

The DocumentWorkstation 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 DocumentWorkstation object does not define any support functions; it inherits all the support functions available to its superclass.

Status

Experimental. Only postscript and PDF formats are supported. New in NCL 5.2.0.