General KERNEL Documentation     End User KERNEL Services  


Engines::TestComponent Interface Reference

import "SALOME_TestComponent.idl";

Inherits Engines::Component.

Inheritance diagram for Engines::TestComponent:

Inheritance graph

Public Member Functions

string Coucou (in long L)
void Setenv ()
void ping ()
long getStudyId ()
void destroy ()
Container GetContainerRef ()
void setProperties (in FieldsDict dico)
FieldsDict getProperties ()
void Names (in string aGraphName, in string aNodeName)
boolean Kill_impl ()
boolean Stop_impl ()
boolean Suspend_impl ()
boolean Resume_impl ()
long CpuUsed_impl ()
TMPFile DumpPython (in Object theStudy, in boolean isPublished, out boolean isValidScript)

Data Fields

readonly attribute string instanceName
readonly attribute string interfaceName

Member Function Documentation

string Engines::TestComponent::Coucou in long  L  ) 
 

void Engines::TestComponent::Setenv  ) 
 

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

Returns:
-1: not initialised (Internal Error) 0: multistudy component instance >0: study id associated to this instance

void Engines::Component::destroy  )  [inherited]
 

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]
 

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]
 

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]
 

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]
 

Returns True if the Component has been killed.

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

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

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

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

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

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

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

Returns the Cpu used (long does not run with python !...)

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

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


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