Engines::TestComponent Interface Reference

a component with 2 operations (Coucou and Setenv) More...

import "SALOME_TestComponent.idl";

Inheritance diagram for Engines::TestComponent:

Public Member Functions
string	Coucou (in long L)
void	Setenv ()
void	ping ()
	Determines whether the server has already been loaded or not. More...
long	getStudyId ()
	Get study associated to component instance. More...
void	destroy ()
	Remove component instance from container. More...
Container	GetContainerRef ()
	Returns the container that the Component refers to. More...
void	setProperties (in FieldsDict dico)
	Set component instance properties. More...
FieldsDict	getProperties ()
	Get component instance properties. More...
void	SetOption (in string optionName, in string value)
	Set an option value. More...
string	GetOption (in string optionName)
	Return an option value. More...
void	Names (in string aGraphName, in string aNodeName)
	Set name of a node in a graph (for SUPERVISOR use) More...
boolean	Kill_impl ()
	Kill the component (if you can) More...
boolean	Stop_impl ()
	Stop the component (if you can) More...
boolean	Suspend_impl ()
	Suspend the component. More...
boolean	Resume_impl ()
	Resume the component. More...
long	CpuUsed_impl ()
	Get the cpu used. More...
TMPFile	DumpPython (in Object theStudy, in boolean isPublished, in boolean isMultiFile, out boolean isValidScript)
	Get a python dump. More...
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. More...
void	checkInputFilesToService (in string service_name) raises (SALOME::SALOME_Exception)
	Check service input files (transfer them if needed) More...
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. More...
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. More...
void	checkOutputFilesToService (in string service_name) raises (SALOME::SALOME_Exception)
	Check service output files (transfer them if needed) More...
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. More...
boolean	hasObjectInfo ()
	Indicate if the component instance provides custom information about its objects. More...
string	getObjectInfo (in long studyId, in string entry)
	Get custom information about the given object. More...
string	getVersion ()
	Get version of the component. More...

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

Detailed Description

a component with 2 operations (Coucou and Setenv)

Member Function Documentation

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_name

service's name.

Exceptions

contains

informations 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_name

service's name.

Exceptions

contains

informations about files that are not in a good state.

string Engines::TestComponent::Coucou

(

in long

L

)

long Engines::EngineComponent::CpuUsed_impl ( )

inherited

Get the cpu used.

Returns the Cpu used

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_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.

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

entry	object's entry.
studyId	study 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_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.

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).

long Engines::EngineComponent::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

string Engines::EngineComponent::getVersion ( )

inherited

Get version of the component.

This method is supposed to be implemented in all derived classes; default implementation returns "unknown" string that means that no version information about the component is available.

Note

The version of the component is stored to the study, as a part of general persistence mechanism; once stored, version information in the study cannot be changed.

Returns

string containing component's version, e.g. "1.0"

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

aGraphName	Name of graph
aNodeName	Name 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.

void Engines::TestComponent::Setenv

(

)

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_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.

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_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.

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.

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)

Field Documentation

readonly attribute string Engines::EngineComponent::instanceName

inherited

The name of the instance of the Component.

readonly attribute string Engines::EngineComponent::interfaceName

inherited

The name of the interface of the Component.