Plugin-Related State Objects

Revision as of 20:21, 20 March 2014 by BradWhitlock (talk | contribs) (FileOpenOptions)

There are various state objects that relate to how VisIt maintains track of plugins. This page is an attempt to describe some the of state objects and how they are used in VisIt.

  • PluginManagerAttributes
  • DBPluginInfoAttributes
  • DBOptionsAttributes
  • ExportDBAttributes
  • FileOpenOptions

PluginManagerAttributes

The viewer populates the PluginManagerAttributes with the available plot and operator plugins. The object is sent to clients after the viewer is initialized so the client can load the same list of plugins as the viewer so the ViewerProxy interface contains the same state objects.

DBPluginInfoAttributes

This state object is populated in the mdserver using the list of plugins that are loaded there. The object contains information for the database plugins that comes from each plugin's common info. The information is sent to the viewer and ultimately to the clients so they can know about the plugins (and characteristics) for a specified host. The state object contains the read and write options (DBOptionsAttributes) for a plugin and the VisIt GUI uses these options to create a custom window for reading databases and for database export.

DBOptionsAttrbutes

This state object can describe the read or write options for a plugin. The DBPluginInfoAttributes contain vectors of DBOptionsAttributes that contain the names,types,and default values of the options. The FileOpenOptions uses this class as well to keep the current read options that have been set for database plugins.

ExportDBAttributes

This state object allows the user to specify general options used for exporting databases. Part of the information is a DBOptionsAttributes object that can be used to tell the database writer plugin more information about how the database should be exported.

FileOpenOptions

The FileOpenOptions state object contains a vector of DBOptionsAttributes that contain the current read options in place for all file formats. When VisIt opens a file, the FileOpenOptions are passed to the mdserver and the engine to ensure that database reader plugins read their data taking into account the read options.