NCL Website header
NCL Home > Documentation > HLUs > Classes

PDFWorkstation class

The PDFWorkstation object manages communication with the NCAR Graphics PDF Workstation output device.

Synopsis

Header file:		ncarg/hlu/PDFWorkstation.h
Class name:		pdfWorkstationClass
Class pointer:		NhlpdfWorkstationClass
Fortran class function:	NHLFPDFWORKSTATIONCLASS
Superclass:		Workstation
Composite classes:	<None>

Class-defined types

Type name:		NhlTPDFFormat
Definition:		typedef enum {
				NhlPDF		= 0,	/* "PDF" */
			} NhlPDFFormat;

Resources

Local resources

+---------------------------------------------------------------+
|			PDFWorkstation resource set		|
|---------------------------------------------------------------|
| NAME				TYPE			ACCESS	|
|	CLASS				DEFAULT			|
|===============================================================|
| wkPDFFormat			NhlTPDFFormat		RCG	|
|	WkPDFFormat			"pdf"			|
|---------------------------------------------------------------|
| wkColorModel			NhlTColorModel		RCG	|
|	WkColorModel			"rgb"			|
|---------------------------------------------------------------|
| wkVisualType			NhlTVisualType		RCG	|
|	WkVisualType			"color"			|
|---------------------------------------------------------------|
| wkOrientation			NhlTWorkOrientation	RCSG	|
|	WkOrientation			"portrait"		|
|---------------------------------------------------------------|
| wkPDFFileName			NhlTString		RCG	|
|	WkPDFFileName			<dynamic>		|
|---------------------------------------------------------------|
| wkFullBackground		NhlTBoolean		RCSG	|
|	WkPDFFileName			False			|
|---------------------------------------------------------------|
| wkPDFResolution		NhlTInteger		RCG	|
|	WkPDFResolution			1800			|
|---------------------------------------------------------------|
| wkDeviceLowerX		NhlTInteger		RCSG	|
|	WkDeviceLowerX			36			|
|---------------------------------------------------------------|
| wkDeviceLowerY		NhlTInteger		RCSG	|
|	WkDeviceLowerY			126			|
|---------------------------------------------------------------|
| wkDeviceUpperX		NhlTInteger		RCSG	|
|	WkDeviceUpperX			576			|
|---------------------------------------------------------------|
| wkDeviceUpperY		NhlTInteger		RCSG	|
|	WkDeviceUpperY			666			|
|---------------------------------------------------------------|
| wkPaperSize      		NhlTString		RCG	|
|	WkPaperSize			"letter"		|
|---------------------------------------------------------------|
| wkPaperWidthF    		NhlTFloat		RCG	|
|	WkPaperWidthF			<dynamic>		|
|---------------------------------------------------------------|
| wkPaperHeightF		NhlTFloat		RCG	|
|	WkPaperHeightF			<dynamic>		|
+---------------------------------------------------------------+

Composite resources

The PDFWorkstation object class has no composite class members.

Superclass resources

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


Description

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

Status


See also