General KERNEL Documentation     End User KERNEL Services  


SALOME_ComponentPy::SALOME_ComponentPy_i Class Reference

Inheritance diagram for SALOME_ComponentPy::SALOME_ComponentPy_i:

Inheritance graph
Collaboration diagram for SALOME_ComponentPy::SALOME_ComponentPy_i:

Collaboration graph

Public Member Functions

def __init__
def _get_instanceName
def _get_interfaceName
def ping
def setProperties
def getProperties
def destroy
def GetContainerRef
def beginService
def endService
def sendMessage
def Names
def graphName
def nodeName
def Killer
def Kill_impl
def Stop_impl
def Suspend_impl
def Resume_impl
def CpuUsed_impl
def DumpPython
def getStudyId
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

Private Attributes

 _instanceName
 _interfaceName
 _containerName
 _notif
 _myConnexionToRegistry
 _graphName
 _nodeName
 _ThreadId
 _StartUsed
 _ThreadCpuUsed
 _Executed
 _contId
 _notifSupplier
 _fieldsDict
 _serviceName

Static Private Attributes

 _orb = None
 _poa = None
list _fieldsDict = []
int _studyId = 1

Member Function Documentation

def SALOME_ComponentPy::SALOME_ComponentPy_i::__init__   self,
  orb,
  poa,
  contID,
  containerName,
  instanceName,
  interfaceName,
  notif = 0
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::_get_instanceName   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::_get_interfaceName   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::ping   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::setProperties   self,
  dico
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::getProperties   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::destroy   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::GetContainerRef   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::beginService   self,
  serviceName
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::endService   self,
  serviceName
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::sendMessage   self,
  event_type,
  message
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Names   self,
  GraphName,
  NodeName
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::graphName   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::nodeName   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Killer   self,
  ThreadId,
  signum
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Kill_impl   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Stop_impl   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Suspend_impl   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::Resume_impl   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::CpuUsed_impl   self  ) 
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::DumpPython   self,
  theStudy,
  isPublished
 

def SALOME_ComponentPy::SALOME_ComponentPy_i::getStudyId   self  ) 
 

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

SALOME_ComponentPy::SALOME_ComponentPy_i::_orb = None [static, private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_poa = None [static, private]
 

list SALOME_ComponentPy::SALOME_ComponentPy_i::_fieldsDict = [] [static, private]
 

int SALOME_ComponentPy::SALOME_ComponentPy_i::_studyId = 1 [static, private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_instanceName [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_interfaceName [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_containerName [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_notif [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_myConnexionToRegistry [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_graphName [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_nodeName [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_ThreadId [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_StartUsed [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_ThreadCpuUsed [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_Executed [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_contId [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_notifSupplier [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_fieldsDict [private]
 

SALOME_ComponentPy::SALOME_ComponentPy_i::_serviceName [private]
 

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