Imagine::ClientViewer Class Reference

#include <Viewer.h>

Inheritance diagram for Imagine::ClientViewer:

Inheritance graph
[legend]
Collaboration diagram for Imagine::ClientViewer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

boost::shared_ptr< Evue_Connection > openConnection ()
void setVirtualRoam (bool)
void setStatusBar (bool)
Evue_DisplayHandle selectExistingViewer ()
Evue_DisplayHandle createViewer ()
Evue_DisplayHandle displayHandle ()
Evue_LayerHandle topLayer ()
Estr_StringList * openGenericLayer (std::string const &data_filename)
boost::shared_ptr< Evue_Connection > connection ()
void closeConnection ()

Protected Member Functions

Imp const * imp () const
 return reference to internal state object
Imp * imp ()

Detailed Description

Viewer for tradtional client EML application that runs separately from a Viewer and communicates with it over a pipe through the Session Manager


Member Function Documentation

void Imagine::Viewer::closeConnection  )  [inherited]
 

close a viewer connection

Imagine::ErrorReportException Problem closing a viewer connection

boost::shared_ptr<Evue_Connection> Imagine::Viewer::connection  )  [inherited]
 

return the current viewer connection

Note:
boost::shared<Evue_Connection> because we make use of a deleter function that automatically insures that the connection is released when the last referring shared pointer is destroyed.

Returns:
the current viewer connection, or 0 if there currently isn't one

Evue_DisplayHandle Imagine::ClientViewer::createViewer  ) 
 

returns a display handle to a newly created viewer

Imagine::ErrorReportException Unable to create a new viewer

Evue_DisplayHandle Imagine::ClientViewer::displayHandle  ) 
 

return the current display handle

boost::shared_ptr<Evue_Connection> Imagine::ClientViewer::openConnection  )  [virtual]
 

open a connection to a running viewer

Returns:
A shared pointer to the connection.
Remarks:
XXX Or session manager? I'm not sure which. I think this just opens the pipe to the session manager and otherwise prepares for communication with a viewer through the session manager.

Imagine::ErrorReportException Unable to open a connection to a viewer

Implements Imagine::Viewer.

Estr_StringList* Imagine::ClientViewer::openGenericLayer std::string const &  data_filename  ) 
 

Open a generic layer on the viewer

Parameters:
data_filename refers to the file containing spatial data

Evue_DisplayHandle Imagine::ClientViewer::selectExistingViewer  ) 
 

return a display handle to a currently running viewer

Imagine::ErrorReportException Problem while trying to select existing viewer

void Imagine::ClientViewer::setStatusBar bool   )  [virtual]
 

Set whether viewer's status bar is visible or not

Implements Imagine::Viewer.

void Imagine::ClientViewer::setVirtualRoam bool   )  [virtual]
 

toggles on/off virtual roam feature

Remarks:
No idea what this is; as usual, poorly documented. >:o
Precondition:
viewer and its display is set up
Imagine::ErrorReportException Unable to set virtual roam

Implements Imagine::Viewer.

Evue_LayerHandle Imagine::ClientViewer::topLayer  ) 
 

return handle to top viewer layer


The documentation for this class was generated from the following file:
Generated on Wed Mar 7 16:49:37 2007 for ImagineObjects by  doxygen 1.4.6