SALOME documentation central

Engines::TestMPIComponent Interface Reference

Inheritance diagram for Engines::TestMPIComponent:
Inheritance graph

Public Member Functions

void Coucou (in long L)
oneway void SPCoucou (in long L)
void ping ()
 Determines whether the server has already been loaded or not.
long getStudyId ()
 Get study associated to component instance.
void destroy ()
 Remove component instance from container.
Container GetContainerRef ()
 Returns the container that the Component refers to.
void setProperties (in FieldsDict dico)
 Set component instance properties.
FieldsDict getProperties ()
 Get component instance properties.
void Names (in string aGraphName, in string aNodeName)
 Set name of a node in a graph (for SUPERVISOR use).
boolean Kill_impl ()
 Kill the component (if you can).
boolean Stop_impl ()
 Stop the component (if you can).
boolean Suspend_impl ()
 Suspend the component.
boolean Resume_impl ()
 Resume the component.
long CpuUsed_impl ()
 Get the cpu used.
TMPFile DumpPython (in Object theStudy, in boolean isPublished, out boolean isValidScript)
 Get a python dump.
Engines::Salome_file getInputFileToService (in string service_name, in string Salome_file_name) raises (SALOME::SALOME_Exception)
 Returns a CORBA Ref of a input Salome_file managed by a service.
void checkInputFilesToService (in string service_name) raises (SALOME::SALOME_Exception)
 Check service input files (transfer them if needed).
Engines::Salome_file setInputFileToService (in string service_name, in string Salome_file_name) raises (SALOME::SALOME_Exception)
 This method adds a input Salome_file to a service of the component.
Engines::Salome_file getOutputFileToService (in string service_name, in string Salome_file_name) raises (SALOME::SALOME_Exception)
 Returns a CORBA Ref of a output Salome_file managed by a service.
void checkOutputFilesToService (in string service_name) raises (SALOME::SALOME_Exception)
 Check service output files (transfer them if needed).
Engines::Salome_file setOutputFileToService (in string service_name, in string Salome_file_name) raises (SALOME::SALOME_Exception)
 This method adds an output Salome_file to a service of the component.
boolean hasObjectInfo ()
 Indicate if the component instance provides custom information about its objects.
string getObjectInfo (in long studyId, in string entry)
 Get custom information about the given object.

Data Fields

readonly attribute string instanceName
 The name of the instance of the Component.
readonly attribute string interfaceName
 The name of the interface of the Component.
attribute IORTab tior

Member Function Documentation

void Engines::Component::ping (  )  [inherited]

Determines whether the server has already been loaded or not.

long Engines::Component::getStudyId (  )  [inherited]

Get study associated to component instance.

get study associated to component instance

Returns:
-1: not initialised (Internal Error) 0: multistudy component instance >0: study id associated to this instance
void Engines::Component::destroy (  )  [inherited]

Remove component instance from container.

Deactivates the Component. -- TO BE USED BY CONTAINER ONLY (Container housekeeping) -- use remove_impl from Container instead !

Container Engines::Component::GetContainerRef (  )  [inherited]

Returns the container that the Component refers to.

void Engines::Component::setProperties ( in FieldsDict  dico  )  [inherited]

Set component instance properties.

Gives a sequence of (key=string,value=any) to the component. Base class component stores the sequence in a map. The map is cleared before. This map is for use by derived classes.

FieldsDict Engines::Component::getProperties (  )  [inherited]

Get component instance properties.

returns a previously stored map (key=string,value=any) as a sequence. See setProperties(in FieldsDict dico).

void Engines::Component::Names ( in string  aGraphName,
in string  aNodeName 
) [inherited]

Set name of a node in a graph (for SUPERVISOR use).

This method is used by the SUPERVISOR component. It sets the names of the graph and of the node.

Parameters:
aGraphName Name of graph
aNodeName Name of node
boolean Engines::Component::Kill_impl (  )  [inherited]

Kill the component (if you can).

Returns True if the Component has been killed.

boolean Engines::Component::Stop_impl (  )  [inherited]

Stop the component (if you can).

Returns True if the activity of the Component has been stopped. (It's action can't be resumed)

boolean Engines::Component::Suspend_impl (  )  [inherited]

Suspend the component.

Returns True if the activity of the Component has been suspended. (It's action can be resumed)

boolean Engines::Component::Resume_impl (  )  [inherited]

Resume the component.

Returns True if the activity of the Component has been resumed.

long Engines::Component::CpuUsed_impl (  )  [inherited]

Get the cpu used.

Returns the Cpu used

TMPFile Engines::Component::DumpPython ( in Object  theStudy,
in boolean  isPublished,
out boolean  isValidScript 
) [inherited]

Get a python dump.

Returns a python script, which is being played back reproduces the data model of component

Engines::Salome_file Engines::Component::getInputFileToService ( in string  service_name,
in string  Salome_file_name 
) raises (SALOME::SALOME_Exception) [inherited]

Returns a CORBA Ref of a input Salome_file managed by a service.

Parameters:
service_name service's name.
file_name name of the requested file.
Returns:
CORBA Ref of the requested file.
Exceptions:
contains informations of what if the component cannot sends the file's reference.
void Engines::Component::checkInputFilesToService ( in string  service_name  )  raises (SALOME::SALOME_Exception) [inherited]

Check service input files (transfer them if needed).

This method is used before the activation of the service. It calls recvFiles() on all the input Salome_file files of the service.

Before each recvFiles(), it uses the callback method named configureSalome_file. This method allows the user to configure the files managed by the Salome_file.

By default, there is no files managed when a Salome_file is created, but the supervisor set some files managed by the Salome_file from the information contained into the schema file.

Parameters:
service_name service's name.
Exceptions:
contains informations about files that are not in a good state.
Engines::Salome_file Engines::Component::setInputFileToService ( in string  service_name,
in string  Salome_file_name 
) raises (SALOME::SALOME_Exception) [inherited]

This method adds a input Salome_file to a service of the component.

Parameters:
service_name service's name.
Salome_file_name name of the Salome_file
Returns:
a reference of the Salome_file
Exceptions:
raises an exception if there is already a Salome_file with this name for the service.
Engines::Salome_file Engines::Component::getOutputFileToService ( in string  service_name,
in string  Salome_file_name 
) raises (SALOME::SALOME_Exception) [inherited]

Returns a CORBA Ref of a output Salome_file managed by a service.

Parameters:
service_name service's name.
file_name name of the requested file.
Returns:
CORBA Ref of the requested file.
Exceptions:
contains informations of what if the component cannot sends the file's reference.
void Engines::Component::checkOutputFilesToService ( in string  service_name  )  raises (SALOME::SALOME_Exception) [inherited]

Check service output files (transfer them if needed).

This method is used at the end of the service. It calls recvFiles() on all the output Salome_file files of the service.

Before each recvFiles(), it uses the callback method named configureSalome_file. This method allows the user to configure the files managed by the Salome_file.

By default, there is no files managed when a Salome_file is created, but the supervisor set some files managed by the Salome_file from the information contained into the schema file.

Parameters:
service_name service's name.
Exceptions:
contains informations about files that are not in a good state.
Engines::Salome_file Engines::Component::setOutputFileToService ( in string  service_name,
in string  Salome_file_name 
) raises (SALOME::SALOME_Exception) [inherited]

This method adds an output Salome_file to a service of the component.

Parameters:
service_name service's name.
Salome_file_name name of the Salome_file
Returns:
a reference of the Salome_file
Exceptions:
raises an exception if there is already a Salome_file with this name for the service.
boolean Engines::Component::hasObjectInfo (  )  [inherited]

Indicate if the component instance provides custom information about its objects.

Returns true if the component provides custom information about its objects, false otherwise. Should be redefined in the certain component to return true in case of this component provides such information.

string Engines::Component::getObjectInfo ( in long  studyId,
in string  entry 
) [inherited]

Get custom information about the given object.

This method is used to get the custom information about the given object. Should be redefined in the certain component in case of this component provides such information. It is worth using this method only if hasObjectInfo() method returns true.

Parameters:
entry object's entry.
studyId study id
Returns:
an information about the given object.

Field Documentation

readonly attribute string Engines::Component::instanceName [inherited]

The name of the instance of the Component.

readonly attribute string Engines::Component::interfaceName [inherited]

The name of the interface of the Component.


Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS