NCL Home > Documentation > HLUs > Classes

NcgmWorkstation class

The NcgmWorkstation manages communication with the NCAR Graphcs CGM Workstation output device.

Synopsis

Header file:		ncarg/hlu/NcgmWorkstation.h
Class name:		ncgmWorkstationClass
Class pointer:		NhlncgmWorkstationClass
Fortran class function:	NHLFNCGMWORKSTATIONCLASS
Superclass:		Workstation
Composite classes:	<None>

Resources

Local resources

+---------------------------------------------------------------+
|			NcgmWorkstation Resource Set		|
|---------------------------------------------------------------|
| NAME				TYPE			ACCESS	|
|	CLASS				DEFAULT			|
|===============================================================|
| wkMetaName			NhlTString		RCG	|
|       WkMetaName                      "gmeta"                 |
+---------------------------------------------------------------+

Composite resources

The NcgmWorkstation object class has no composite class objects.

Superclass resources

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

Workstation resources

Description

The NcgmWorkstation object is derived from the Workstation object class. It inherits all of the color map management and workstation management functions of the Workstation class. The NcgmWorkstation opens and creates an output metafile. Whenever a child of the workstation is drawn, all output is written into the output metafile. The output metafile can be viewed using standard NCAR Graphics CGM viewing tools. The output metafile can also be translated into many other device formats using the NCAR Graphics application called ctrans.

This class adds only one resource to the Workstation set of resources. This resource enables the user to specify a full Unix path name for the output metafile.

An important thing to remember is that only one NcgmWorkstation object can be created at a time. Therefore, you must destroy the current instance of the NcgmWorkstation object before creating a new one. You can use the NhlDestroy function for this purpose.

Another thing to remember with the NcgmWorkstation object, is that the metafile is written using FORTRAN I/O. This means that the NcgmWorkstation object uses one of the available UNIT numbers. The NcgmWorkstation starts with UNIT 7, and increments until it finds a UNIT number that is not currently in use.

Support functions

The NcgmWorkstation object does not define any support functions, but inherits all the support functions available to its superclasses. This includes all the Workstation class functions.