ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
pqServerConnectReaction Class Reference

Reaction for connecting to a server. More...

#include <pqServerConnectReaction.h>

Inheritance diagram for pqServerConnectReaction:
Inheritance graph
[legend]
Collaboration diagram for pqServerConnectReaction:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 pqServerConnectReaction (QAction *parent)
 Constructor. Parent cannot be NULL.

Static Public Member Functions

static void connectToServerWithWarning ()
 Creates a server connection.
static void connectToServer ()
static bool connectToServerUsingConfigurationName (const char *config_name)
 ParaView names server configurations (in pvsc files).
static bool connectToServerUsingConfiguration (const pqServerConfiguration &config)
 To connect to a server given a configuration, use this API.
static bool connectToServer (const pqServerResource &resource)
 Connect to server using the resource.

Protected Member Functions

virtual void onTriggered ()
 Called when the action is triggered.

Detailed Description

Reaction for connecting to a server.

Definition at line 42 of file pqServerConnectReaction.h.


Constructor & Destructor Documentation

pqServerConnectReaction::pqServerConnectReaction ( QAction *  parent)

Constructor. Parent cannot be NULL.


Member Function Documentation

static void pqServerConnectReaction::connectToServerWithWarning ( ) [static]

Creates a server connection.

Note that this method is static. Applications can simply use this without having to create a reaction instance.

static void pqServerConnectReaction::connectToServer ( ) [static]
static bool pqServerConnectReaction::connectToServerUsingConfigurationName ( const char *  config_name) [static]

ParaView names server configurations (in pvsc files).

To connect to a server using the configuration specified, use this API.

static bool pqServerConnectReaction::connectToServerUsingConfiguration ( const pqServerConfiguration config) [static]

To connect to a server given a configuration, use this API.

static bool pqServerConnectReaction::connectToServer ( const pqServerResource resource) [static]

Connect to server using the resource.

This will create a temporary configuration for the resource.

virtual void pqServerConnectReaction::onTriggered ( ) [inline, protected, virtual]

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 70 of file pqServerConnectReaction.h.


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