plotms_private.h

Go to the documentation of this file.

// The Private declarations of the PlotMS component.

// Static //

// Constants for how long to wait for the casapy application to launch, in
// microseconds.
// <group>
static const unsigned int LAUNCH_WAIT_INTERVAL_US;
static const unsigned int LAUNCH_TOTAL_WAIT_US;
// </group>

// Implementation of casapy_watcher for use with plotms component.
class plotms_watcher : public CasapyWatcher {
public:
    // Constructor which takes parent.
    plotms_watcher(plotms *pl) : p(pl) { CasapyWatcher::registerWatcher(this); }
    
    // Destructor.
    ~plotms_watcher() { }
    
    // Overrides casapy_watcher::logChanged().
    // <group>
    void logChanged(const String& sinkLocation) {
        p->setLogFilename(sinkLocation); }
    void logChanged(LogMessage::Priority filterPriority) {
        p->setLogFilter(LogMessage::toString(filterPriority).c_str()); }
    // </group>
    
    // Overrides casapy_watcher::casapyClosing().
    void casapyClosing() { p->closeApp(); }
    
private:
    // Plotms parent.
    plotms *p;
};

class plotms_app  {
public:
  plotms_app( ) { }
  const String &dbusName( ) const { return itsDBusName_; }
  String &dbusName( ) { return itsDBusName_; }
  // DBus name of the plotms application we're communicating with.
  const QString &getName( ) const { return PlotMSDBusApp::name( ); }
 private:
  String itsDBusName_;
};

// Non-Static //

// must forward declare & use a pointer because build system
// does not allow extra include in plotms_cmpt.h...
plotms_app app;

// Casapy watcher.
plotms_watcher itsWatcher_;

// Log parameters that are set before the application is launched.
// <group>
String itsLogFilename_, itsLogFilter_;
// </group>


// Returns true if the DISPLAY environment variable is set, false otherwise.
// If not set, an error message is printed.
bool displaySet();

// Launches the dbus plotms application IF it is not already launched.
void launchApp();

// Closes the launched dbus plotms application if needed.
void closeApp();

// Helper method for calling an async method.
void callAsync(const String& methodName);

// Helper method for realizing synchronous behavior
void waitUntilIdle();

// Helper method for setting the MS selection.
void setPlotMSSelection_(const PlotMSSelection& selection,
        const bool updateImmediately, const int plotIndex);

// Helper method for setting the MS averaging.
void setPlotMSAveraging_(const PlotMSAveraging& averaging,
        const bool updateImmediately, const int plotIndex);

// Helper method for setting the MS transformations.
void setPlotMSTransformations_(const PlotMSTransformations& trans,
        const bool updateImmediately, const int plotIndex);

// Helper method for setting the iteration parameters
void setPlotMSIterate_(const PlotMSIterParam& iter,
        const bool updateImmediately, const int plotIndex);

// Helper method for setting the flag extension.
void setFlagging_(const PlotMSFlagging& flagging);

// Bool that turns on iteration
bool doIter_;