Back to index

salome-paravis  6.5.0
Public Member Functions
PARAVIS::PARAVIS_Gen Interface Reference

The main interface class for PARAVIS server. More...

import "PARAVIS_Gen.idl";

List of all members.

Public Member Functions

string GetIOR ()
 Returns IOR of the current object.
void ImportFile (in string theFileName)
 Import file to PARAVIS module.
void ExecuteScript (in string script)
string GetTrace ()
 Returns trace string if trace is activated for current session.
void SaveTrace (in string theFileName)
 Save trace sting to a disk file.
string_array GetClassesList ()
 Returns list of names of extracted Paraview and VTK classes.
PARAVIS_Base CreateClass (in string theClassName)
 Returns container class for the requested Paraview class.
void GetConnectionParameters (out long theId, out string theDHost, out long theDPort, out string theRHost, out long theRPort, out long theReversed)
 Returns parameters of current (usually built-in) connection which is active in GUI (Paraview client).
void ActivateModule ()
 Activates GUI of PARAVIS module.
void SetCurrentStudy (in SALOMEDS::Study theStudy)
 Sets a definite study to be current.
SALOMEDS::Study GetCurrentStudy ()
 Gets the current study.

Detailed Description

The main interface class for PARAVIS server.

Instantiation of this class has to be done before access to any other PARAVIS interfaces

Definition at line 57 of file PARAVIS_Gen.idl.


Member Function Documentation

Activates GUI of PARAVIS module.

If module is active then do nothing. GUI must be active before call of any server manager API function. This function is called on activation paravis python module.

PARAVIS_Base PARAVIS::PARAVIS_Gen::CreateClass ( in string  theClassName)

Returns container class for the requested Paraview class.

void PARAVIS::PARAVIS_Gen::ExecuteScript ( in string  script)

Returns list of names of extracted Paraview and VTK classes.

void PARAVIS::PARAVIS_Gen::GetConnectionParameters ( out long  theId,
out string  theDHost,
out long  theDPort,
out string  theRHost,
out long  theRPort,
out long  theReversed 
)

Returns parameters of current (usually built-in) connection which is active in GUI (Paraview client).

Parameters:
theId- connection ID
theDHost- name of data host
theDPort- number of data port
theRHost- name of representation host
theRPort- number of representation port
theReversed- returns 1 or 0 depending on server resource scheme

Gets the current study.

Returns IOR of the current object.

Returns trace string if trace is activated for current session.

Otherwise it returns empty string.

void PARAVIS::PARAVIS_Gen::ImportFile ( in string  theFileName)

Import file to PARAVIS module.

File can be of any type supported by Paraview and installed plug-ins.

void PARAVIS::PARAVIS_Gen::SaveTrace ( in string  theFileName)

Save trace sting to a disk file.

Parameters:
theFileName- name of file.
void PARAVIS::PARAVIS_Gen::SetCurrentStudy ( in SALOMEDS::Study  theStudy)

Sets a definite study to be current.


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