casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
casa::PlotMSParameters Class Reference

Subclass of PlotMSWatchedParameters that hold parameters for the whole plotter. More...

#include <PlotMSParameters.h>

Inheritance diagram for casa::PlotMSParameters:
casa::PlotMSWatchedParameters

List of all members.

Public Member Functions

 PlotMSParameters (const String &logFilename=PMS::DEFAULT_LOG_FILENAME, int logEvents=PMS::DEFAULT_LOG_EVENTS, LogMessage::Priority logPriority=PMS::DEFAULT_LOG_PRIORITY, bool clearSelections=PMS::DEFAULT_CLEAR_SELECTIONS, int cachedImageWidth=PMS::DEFAULT_CACHED_IMAGE_WIDTH, int cachedImageHeight=PMS::DEFAULT_CACHED_IMAGE_HEIGHT)
 Non-Static //.
 PlotMSParameters (const PlotMSParameters &copy)
 Copy constructor.
 ~PlotMSParameters ()
 Destructor.
String logFilename () const
 Gets/Sets the log sink location/filename.
void setLogFilename (const String &filename)
int logEvents () const
 Returns the current log events.
LogMessage::Priority logPriority () const
 Returns the current log minimum priority.
void setLogFilter (int logEvents, LogMessage::Priority priority)
 Sets the current log filter.
bool clearSelectionsOnAxesChange () const
 Gets/Sets whether any selections are cleared when plot axes are changed or not.
void setClearSelectionsOnAxesChange (bool flag)
pair< int, int > cachedImageSize () const
 Gets/Sets the cached image size.
void setCachedImageSize (int width, int height)
void setCachedImageSizeToResolution ()
 Sets the cached image size to the current screen resolution.
PlotMSParametersoperator= (const PlotMSParameters &copy)
 Copy operator.
bool equals (const PlotMSWatchedParameters &other, int updateFlags) const
 Implements PlotMSWatchedParameters::equals().

Static Public Member Functions

static int chooserHistoryLimit ()
 Gets/Sets the file chooser history limit.
static void setChooserListoryLimit (int histLimit)

Static Public Attributes

static const int UPDATE_LOG
 Static //.
static const int UPDATE_PLOTMS_OPTIONS

Private Attributes

String itsLogFilename_
 Log filename.
int itsLogEvents_
 Log events flag.
LogMessage::Priority itsLogPriority_
 Log minimum priority.
bool itsClearSelectionsOnAxesChange_
 Clear selections on axes change flag.
int itsCachedImageWidth_
 Cached image sizes.
int itsCachedImageHeight_

Detailed Description

Subclass of PlotMSWatchedParameters that hold parameters for the whole plotter.

These parameters include: log file name log events flag log minimum priority filter whether to clear any selections when axes are changed or not width and height for the cached image

Definition at line 43 of file PlotMSParameters.h.


Constructor & Destructor Documentation

casa::PlotMSParameters::PlotMSParameters ( const String logFilename = PMS::DEFAULT_LOG_FILENAME,
int  logEvents = PMS::DEFAULT_LOG_EVENTS,
LogMessage::Priority  logPriority = PMS::DEFAULT_LOG_PRIORITY,
bool  clearSelections = PMS::DEFAULT_CLEAR_SELECTIONS,
int  cachedImageWidth = PMS::DEFAULT_CACHED_IMAGE_WIDTH,
int  cachedImageHeight = PMS::DEFAULT_CACHED_IMAGE_HEIGHT 
)

Non-Static //.

Constructor, with default values for parameters.

Copy constructor.

See operator=().

Destructor.


Member Function Documentation

pair<int, int> casa::PlotMSParameters::cachedImageSize ( ) const

Gets/Sets the cached image size.

See PlotCanvas::cachedAxesStackImageSize().

Gets/Sets the file chooser history limit.

(See QtFileDialog.) Static parameter.

Gets/Sets whether any selections are cleared when plot axes are changed or not.

bool casa::PlotMSParameters::equals ( const PlotMSWatchedParameters other,
int  updateFlags 
) const [virtual]

Implements PlotMSWatchedParameters::equals().

Will return false if the other parameters are not of type PlotMSParameters.

Implements casa::PlotMSWatchedParameters.

Returns the current log events.

Gets/Sets the log sink location/filename.

Returns the current log minimum priority.

PlotMSParameters& casa::PlotMSParameters::operator= ( const PlotMSParameters copy)

Copy operator.

void casa::PlotMSParameters::setCachedImageSize ( int  width,
int  height 
)

Sets the cached image size to the current screen resolution.

static void casa::PlotMSParameters::setChooserListoryLimit ( int  histLimit) [static]
void casa::PlotMSParameters::setLogFilename ( const String filename)
void casa::PlotMSParameters::setLogFilter ( int  logEvents,
LogMessage::Priority  priority 
)

Sets the current log filter.


Member Data Documentation

Definition at line 132 of file PlotMSParameters.h.

Cached image sizes.

Definition at line 132 of file PlotMSParameters.h.

Clear selections on axes change flag.

Definition at line 129 of file PlotMSParameters.h.

Log events flag.

Definition at line 123 of file PlotMSParameters.h.

Log filename.

Definition at line 120 of file PlotMSParameters.h.

Log minimum priority.

Definition at line 126 of file PlotMSParameters.h.

Static //.

Update flags.

Definition at line 49 of file PlotMSParameters.h.

Definition at line 50 of file PlotMSParameters.h.


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