Back to index

salome-kernel  6.5.0
Public Member Functions | Public Attributes
SuperVisionTest::AddComponent Interface Reference

import "AddComponent.idl";

Inheritance diagram for SuperVisionTest::AddComponent:
Inheritance graph
[legend]
Collaboration diagram for SuperVisionTest::AddComponent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

double Add (in double x, in double y, out double z)
double AddWithoutSleep (in double x, in double y, out double z)
void Setx (in double x)
void Sety (in double y)
double Addxy ()
double AddyTox (in double y)
long Sigma (in long n)
double LastResult ()
Adder Addition ()
boolean AdditionObjRef1 (out Adder anAdder)
void AdditionObjRef2 (out boolean FuncValue, out Adder anAdder)
boolean AdditionObjRefs (in AddComponent AddComponent1, in AddComponent Adder2, in AddComponent Adder3, out AddComponent RetAddComponent1, out AddComponent RetAdder2, out AddComponent RetAdder3)
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 SetOption (in string optionName, in string value)
 Set an option value.
string GetOption (in string optionName)
 Return an option value.
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, in boolean isMultiFile, 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.

Public Attributes

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

Detailed Description

Definition at line 34 of file AddComponent.idl.


Member Function Documentation

double SuperVisionTest::AddComponent::Add ( in double  x,
in double  y,
out double  z 
)
void SuperVisionTest::AddComponent::AdditionObjRef2 ( out boolean  FuncValue,
out Adder  anAdder 
)
boolean SuperVisionTest::AddComponent::AdditionObjRefs ( in AddComponent  AddComponent1,
in AddComponent  Adder2,
in AddComponent  Adder3,
out AddComponent  RetAddComponent1,
out AddComponent  RetAdder2,
out AddComponent  RetAdder3 
)
double SuperVisionTest::AddComponent::AddWithoutSleep ( in double  x,
in double  y,
out double  z 
)
double SuperVisionTest::AddComponent::AddyTox ( in double  y)
void Engines::EngineComponent::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_nameservice's name.
Exceptions:
containsinformations about files that are not in a good state.
void Engines::EngineComponent::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_nameservice's name.
Exceptions:
containsinformations about files that are not in a good state.

Get the cpu used.

Returns the Cpu used

Here is the caller graph for this function:

void Engines::EngineComponent::destroy ( ) [inherited]

Remove component instance from container.

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

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

Get a python dump.

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

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

Returns the container that the Component refers to.

Engines::Salome_file Engines::EngineComponent::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_nameservice's name.
file_namename of the requested file.
Returns:
CORBA Ref of the requested file.
Exceptions:
containsinformations of what if the component cannot sends the file's reference.
string Engines::EngineComponent::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:
entryobject's entry.
studyIdstudy id
Returns:
an information about the given object.
string Engines::EngineComponent::GetOption ( in string  optionName) [inherited]

Return an option value.

This method is to get value of an option specific to a certain EngineComponent.

Engines::Salome_file Engines::EngineComponent::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_nameservice's name.
file_namename of the requested file.
Returns:
CORBA Ref of the requested file.
Exceptions:
containsinformations of what if the component cannot sends the file's reference.
FieldsDict Engines::EngineComponent::getProperties ( ) [inherited]

Get component instance properties.

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

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
boolean Engines::EngineComponent::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.

boolean Engines::EngineComponent::Kill_impl ( ) [inherited]

Kill the component (if you can)

Returns True if the Component has been killed.

void Engines::EngineComponent::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:
aGraphNameName of graph
aNodeNameName of node
void Engines::EngineComponent::ping ( ) [inherited]

Determines whether the server has already been loaded or not.

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

Resume the component.

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

Engines::Salome_file Engines::EngineComponent::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_nameservice's name.
Salome_file_namename of the Salome_file
Returns:
a reference of the Salome_file
Exceptions:
raisesan exception if there is already a Salome_file with this name for the service.
void Engines::EngineComponent::SetOption ( in string  optionName,
in string  value 
) [inherited]

Set an option value.

This method is to set an option specific to a certain EngineComponent.

Engines::Salome_file Engines::EngineComponent::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_nameservice's name.
Salome_file_namename of the Salome_file
Returns:
a reference of the Salome_file
Exceptions:
raisesan exception if there is already a Salome_file with this name for the service.
void Engines::EngineComponent::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.

void SuperVisionTest::AddComponent::Setx ( in double  x)
void SuperVisionTest::AddComponent::Sety ( in double  y)
boolean Engines::EngineComponent::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::EngineComponent::Suspend_impl ( ) [inherited]

Suspend the component.

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


Member Data Documentation

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

The name of the instance of the Component.

Definition at line 235 of file SALOME_Component.idl.

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

The name of the interface of the Component.

Definition at line 238 of file SALOME_Component.idl.


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