casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
casa::PlotExportFormat Class Reference

PlotExportFormat contains parameters for exporting a canvas to a file. More...

#include <PlotOptions.h>

Public Types

enum  Type {
  JPG,
  PNG,
  PS,
  PDF,
  TEXT,
  NUM_FMTS
}
 Static //. More...
 
enum  Resolution {
  SCREEN,
  HIGH
}
 Whether to have high resolution or not. More...
 

Public Member Functions

 PlotExportFormat (Type t, const casacore::String &file)
 Non-Static //. More...
 
 ~PlotExportFormat ()
 Destructor. More...
 

Static Public Member Functions

static casacore::String exportFormat (Type t)
 Converts to/from a Type and its casacore::String representation. More...
 
static Type exportFormat (casacore::String t, bool *ok=NULL)
 
static casacore::String extensionFor (Type t)
 Gives/converts the standard extension for export types. More...
 
static Type typeForExtension (casacore::String file, bool *ok=NULL)
 
static std::vector< TypesupportedFormats ()
 Returns all supported export formats. More...
 
static std::vector
< casacore::String
supportedFormatStrings ()
 
static std::vector< TypesupportedImageFormats ()
 Returns all supported image formats. More...
 
static std::vector
< casacore::String
supportedImageFormatStrings ()
 

Public Attributes

Type type
 Public Members. More...
 
bool verbose
 
casacore::String location
 
Resolution resolution
 
int dpi
 
int width
 
int height
 

Detailed Description

PlotExportFormat contains parameters for exporting a canvas to a file.

Definition at line 817 of file PlotOptions.h.

Member Enumeration Documentation

Whether to have high resolution or not.

Enumerator
SCREEN 
HIGH 

Definition at line 828 of file PlotOptions.h.

Static //.

The type of file/export.

Enumerator
JPG 
PNG 
PS 
PDF 
TEXT 
NUM_FMTS 

Definition at line 822 of file PlotOptions.h.

Constructor & Destructor Documentation

casa::PlotExportFormat::PlotExportFormat ( Type  t,
const casacore::String file 
)

Non-Static //.

Sets up a format with the given type and location. Default resolution is SCREEN; default dpi is -1 (unspecified); default width and height are -1 (unspecified). Unspecified values are left up to the plotting implementation.

casa::PlotExportFormat::~PlotExportFormat ( )

Destructor.

Member Function Documentation

static casacore::String casa::PlotExportFormat::exportFormat ( Type  t)
static

Converts to/from a Type and its casacore::String representation.

static Type casa::PlotExportFormat::exportFormat ( casacore::String  t,
bool *  ok = NULL 
)
static
static casacore::String casa::PlotExportFormat::extensionFor ( Type  t)
static

Gives/converts the standard extension for export types.

static std::vector<Type> casa::PlotExportFormat::supportedFormats ( )
static

Returns all supported export formats.

static std::vector<casacore::String> casa::PlotExportFormat::supportedFormatStrings ( )
static
static std::vector<Type> casa::PlotExportFormat::supportedImageFormats ( )
static

Returns all supported image formats.

static std::vector<casacore::String> casa::PlotExportFormat::supportedImageFormatStrings ( )
static
static Type casa::PlotExportFormat::typeForExtension ( casacore::String  file,
bool *  ok = NULL 
)
static

Member Data Documentation

int casa::PlotExportFormat::dpi

Definition at line 875 of file PlotOptions.h.

int casa::PlotExportFormat::height

Definition at line 877 of file PlotOptions.h.

casacore::String casa::PlotExportFormat::location

Definition at line 873 of file PlotOptions.h.

Resolution casa::PlotExportFormat::resolution

Definition at line 874 of file PlotOptions.h.

Type casa::PlotExportFormat::type

Public Members.

Definition at line 871 of file PlotOptions.h.

bool casa::PlotExportFormat::verbose

Definition at line 872 of file PlotOptions.h.

int casa::PlotExportFormat::width

Definition at line 876 of file PlotOptions.h.


The documentation for this class was generated from the following file: