#include <SalomeContainer.hxx>

Inheritance diagram for YACS::ENGINE::SalomeContainer:

[legend]

Collaboration diagram for YACS::ENGINE::SalomeContainer:

[legend]

Public Member Functions
	SalomeContainer ()

	SalomeContainer (const SalomeContainer &other)

	SalomeContainer (const Container &other, const SalomeContainerTools &sct, const SalomeContainerHelper *lmt, const std::vector< std::string > &componentNames, int shutdownLev)

void	lock ()
	For thread safety for concurrent load operation on same Container. More...

void	unLock ()
	For thread safety for concurrent load operation on same Container. More...

std::string	getKind () const

bool	isAlreadyStarted (const Task *askingNode) const
	Check if the component instance container is already started. More...

Engines::Container_ptr	getContainerPtr (const Task *askingNode) const

void	start (const Task *askingNode) override
	Start a salome container (true salome container not yacs one) with given ContainerParameters (_params) More...

void	start (const Task *askingNode, const std::string &resource_name, const std::string &container_name) override

bool	canAcceptImposedResource () override

Container *	clone () const
	WARNING ! clone behaviour MUST be in coherence with what is returned by isAttachedOnCloning() method More...

Container *	cloneAlways () const

std::string	getPlacementId (const Task *askingNode) const
	Get the container placement id for a component instance. More...

std::string	getFullPlacementId (const Task *askingNode) const
	Get the container full path for a component instance. More...

void	checkCapabilityToDealWith (const ComponentInstance *inst) const

void	setProperty (const std::string &name, const std::string &value)

std::string	getProperty (const std::string &name) const

void	clearProperties ()

void	addComponentName (const std::string &name)

void	addToResourceList (const std::string &name)

virtual CORBA::Object_ptr	loadComponent (Task *inst)
	Load a component instance in this container. More...

void	shutdown (int level)

std::map< std::string, std::string >	getResourceProperties (const std::string &name) const

std::map< std::string, std::string >	getProperties () const

Public Member Functions inherited from YACS::ENGINE::Container
virtual std::string	getDiscreminantStrOfThis (const Task *askingNode) const

virtual bool	isUsingPythonCache ()

virtual void	usePythonCache (bool v)

virtual void	setAttachOnCloningStatus (bool val) const

virtual void	attachOnCloning () const

virtual void	dettachOnCloning () const

virtual bool	isAttachedOnCloning () const

virtual bool	isSupportingRTODefNbOfComp () const

virtual void	setProperties (const std::map< std::string, std::string > &properties)

virtual std::string	getName () const

void	setName (std::string name)
	WARNING ! name is used in edition to identify different containers, it is not the runtime name of the container More...

void	setProc (Proc *proc)

Proc *	getProc ()

Public Member Functions inherited from YACS::ENGINE::RefCounter
unsigned int	getRefCnt () const

void	incrRef () const

bool	decrRef () const

Static Public Attributes
static const char	KIND [] ="Salome"

static const char	TYPE_PROPERTY_STR [] ="type"

Static Public Attributes inherited from YACS::ENGINE::Container
static const char	KIND_ENTRY [] ="container_kind"

static const char	AOC_ENTRY [] ="attached_on_cloning"

static const char	USE_PYCACHE_PROPERTY [] ="use_py_cache"

Static Public Attributes inherited from YACS::ENGINE::RefCounter
static unsigned int	_totalCnt =0

Protected Member Functions
virtual	~SalomeContainer ()

Protected Member Functions inherited from YACS::ENGINE::Container
	Container ()

virtual	~Container ()

Protected Member Functions inherited from YACS::ENGINE::RefCounter
	RefCounter ()

	RefCounter (const RefCounter &other)

virtual	~RefCounter ()

Protected Attributes
YACS::BASES::Mutex	_mutex
	thread safety in Salome ??? More...

std::vector< std::string >	_componentNames

SalomeContainerHelper *	_launchModeType

int	_shutdownLevel

SalomeContainerTools	_sct

Protected Attributes inherited from YACS::ENGINE::Container
std::string	_name

bool	_isAttachedOnCloning

Proc *	_proc

Protected Attributes inherited from YACS::ENGINE::RefCounter
unsigned int	_cnt

Friends
class	SalomeComponent

Detailed Description

Definition at line 38 of file SalomeContainer.hxx.

Constructor & Destructor Documentation

◆ SalomeContainer() [1/3]

SalomeContainer::SalomeContainer ( )

Definition at line 58 of file SalomeContainer.cxx.

                                 :_launchModeType(new SalomeContainerMonoHelper),_shutdownLevel(999)
 {
 }

Referenced by clone(), and cloneAlways().

◆ SalomeContainer() [2/3]

SalomeContainer::SalomeContainer ( const SalomeContainer & other )

Definition at line 62 of file SalomeContainer.cxx.

 : Container(other),_componentNames(other._componentNames),
   _launchModeType(other._launchModeType->deepCpyOnlyStaticInfo()),
   _shutdownLevel(other._shutdownLevel),
   _sct(other._sct)
 {
 }

◆ SalomeContainer() [3/3]

SalomeContainer::SalomeContainer	(	const Container &	other,
		const SalomeContainerTools &	sct,
		const SalomeContainerHelper *	lmt,
		const std::vector< std::string > &	componentNames,
		int	shutdownLev
	)

Definition at line 70 of file SalomeContainer.cxx.

                                                                                              :Container(other),_componentNames(componentNames),
                                      _launchModeType(const_cast<SalomeContainerHelper *>(lmt)),_shutdownLevel(shutdownLev),_sct(sct)
 {
   if(lmt)
     lmt->incrRef();
 }

References YACS::ENGINE::RefCounter::incrRef().

◆ ~SalomeContainer()

SalomeContainer::~SalomeContainer ( )

protectedvirtual

Definition at line 78 of file SalomeContainer.cxx.

 {
   _launchModeType->decrRef();
 }

References _launchModeType, and YACS::ENGINE::RefCounter::decrRef().

Member Function Documentation

◆ addComponentName()

void SalomeContainer::addComponentName ( const std::string & name )

virtual

Implements YACS::ENGINE::Container.

Definition at line 165 of file SalomeContainer.cxx.

 {
   _componentNames.push_back(name);
 }

References _componentNames.

◆ addToResourceList()

void SalomeContainer::addToResourceList ( const std::string & name )

Definition at line 170 of file SalomeContainer.cxx.

 {
   _sct.addToResourceList(name);
 }

References _sct, and YACS::ENGINE::SalomeContainerTools::addToResourceList().

◆ canAcceptImposedResource()

bool SalomeContainer::canAcceptImposedResource ( )

overridevirtual

Reimplemented from YACS::ENGINE::Container.

Definition at line 247 of file SalomeContainer.cxx.

 {
   return _launchModeType->getType() == SalomeContainerMultiHelper::TYPE_NAME;
 }

References _launchModeType, YACS::ENGINE::SalomeContainerHelper::getType(), and YACS::ENGINE::SalomeContainerMultiHelper::TYPE_NAME.

Referenced by start().

◆ checkCapabilityToDealWith()

void SalomeContainer::checkCapabilityToDealWith ( const ComponentInstance * inst ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 114 of file SalomeContainer.cxx.

 {
   if(inst->getKind()!=SalomeComponent::KIND)
     throw Exception("SalomeContainer::checkCapabilityToDealWith : SalomeContainer is not able to deal with this type of ComponentInstance.");
 }

References YACS::ENGINE::ComponentInstance::getKind(), and YACS::ENGINE::SalomeComponent::KIND.

◆ clearProperties()

void SalomeContainer::clearProperties ( )

virtual

Implements YACS::ENGINE::Container.

Definition at line 160 of file SalomeContainer.cxx.

 {
   _sct.clearProperties();
 }

References _sct, and YACS::ENGINE::SalomeContainerTools::clearProperties().

◆ clone()

Container * SalomeContainer::clone ( ) const

virtual

WARNING ! clone behaviour MUST be in coherence with what is returned by isAttachedOnCloning() method

Implements YACS::ENGINE::Container.

Definition at line 98 of file SalomeContainer.cxx.

 {
   if(_isAttachedOnCloning)
     {
       incrRef();
       return (Container*) (this);
     }
   else
     return new SalomeContainer(*this);
 }

References YACS::ENGINE::Container::_isAttachedOnCloning, YACS::ENGINE::RefCounter::incrRef(), and SalomeContainer().

◆ cloneAlways()

Container * SalomeContainer::cloneAlways ( ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 109 of file SalomeContainer.cxx.

 {
   return new SalomeContainer(*this);
 }

References SalomeContainer().

◆ getContainerPtr()

Engines::Container_ptr SalomeContainer::getContainerPtr ( const Task * askingNode ) const

Definition at line 214 of file SalomeContainer.cxx.

 {
   return Engines::Container::_duplicate(_launchModeType->getContainer(askingNode));
 }

References _launchModeType, and YACS::ENGINE::SalomeContainerHelper::getContainer().

Referenced by YACS::ENGINE::PythonEntry::GetContainerLog(), GetContainerObj(), and YACS::ENGINE::DistributedPythonNode::load().

◆ getFullPlacementId()

std::string SalomeContainer::getFullPlacementId ( const Task * askingNode ) const

virtual

Get the container full path for a component instance.

Parameters

inst	the component instance

Returns: the full placement id

Implements YACS::ENGINE::Container.

Definition at line 199 of file SalomeContainer.cxx.

 {
   return SalomeContainerTools::GetFullPlacementId(_launchModeType,this,askingNode);
 }

References _launchModeType, and YACS::ENGINE::SalomeContainerToolsBase::GetFullPlacementId().

◆ getKind()

std::string SalomeContainer::getKind ( ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 93 of file SalomeContainer.cxx.

 {
   return KIND;
 }

References KIND.

◆ getPlacementId()

std::string SalomeContainer::getPlacementId ( const Task * askingNode ) const

virtual

Get the container placement id for a component instance.

Parameters

inst	the component instance

Returns: the placement id

Implements YACS::ENGINE::Container.

Definition at line 189 of file SalomeContainer.cxx.

 {
   return SalomeContainerTools::GetPlacementId(_launchModeType,this,askingNode);
 }

References _launchModeType, and YACS::ENGINE::SalomeContainerToolsBase::GetPlacementId().

◆ getProperties()

std::map< std::string, std::string > SalomeContainer::getProperties ( ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 268 of file SalomeContainer.cxx.

 {
   return _sct.getProperties();
 }

References _sct, and YACS::ENGINE::SalomeContainerTools::getProperties().

◆ getProperty()

std::string SalomeContainer::getProperty ( const std::string & name ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 147 of file SalomeContainer.cxx.

 {
   if (name == TYPE_PROPERTY_STR)
     return _launchModeType->getType();
   if (name==AOC_ENTRY)
     {
       int reti(_isAttachedOnCloning);
       std::ostringstream oss; oss << reti;
       return oss.str();
     }
   return _sct.getProperty(name);
 }

References YACS::ENGINE::Container::_isAttachedOnCloning, _launchModeType, _sct, YACS::ENGINE::Container::AOC_ENTRY, YACS::ENGINE::SalomeContainerTools::getProperty(), YACS::ENGINE::SalomeContainerHelper::getType(), and TYPE_PROPERTY_STR.

◆ getResourceProperties()

std::map< std::string, std::string > SalomeContainer::getResourceProperties ( const std::string & name ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 263 of file SalomeContainer.cxx.

 {
   return _sct.getResourceProperties(name);
 }

References _sct, and YACS::ENGINE::SalomeContainerTools::getResourceProperties().

◆ isAlreadyStarted()

bool SalomeContainer::isAlreadyStarted ( const Task * askingNode ) const

virtual

Check if the component instance container is already started.

Parameters

inst	the component instance

Returns: true, if the container is already started, else false

Implements YACS::ENGINE::Container.

Definition at line 209 of file SalomeContainer.cxx.

 {
   return _launchModeType->isAlreadyStarted(askingNode);
 }

References _launchModeType, and YACS::ENGINE::SalomeContainerHelper::isAlreadyStarted().

Referenced by YACS::ENGINE::SalomeContainerTmpForHP::loadComponent().

◆ loadComponent()

CORBA::Object_ptr SalomeContainer::loadComponent ( Task * askingNode )

virtual

Load a component instance in this container.

Parameters

inst	the component instance to load

Reimplemented in YACS::ENGINE::SalomeContainerTmpForHP.

Definition at line 179 of file SalomeContainer.cxx.

 {
   return SalomeContainerTools::LoadComponent(_launchModeType,this,askingNode);
 }

References _launchModeType, and YACS::ENGINE::SalomeContainerToolsBase::LoadComponent().

Referenced by YACS::ENGINE::SalomeComponent::load().

◆ lock()

void SalomeContainer::lock ( )

virtual

For thread safety for concurrent load operation on same Container.

Implements YACS::ENGINE::Container.

Definition at line 83 of file SalomeContainer.cxx.

 {
   _mutex.lock();
 }

References _mutex.

◆ setProperty()

void SalomeContainer::setProperty	(	const std::string &	name,
		const std::string &	value
	)

virtual

Implements YACS::ENGINE::Container.

Definition at line 120 of file SalomeContainer.cxx.

 {
   if (name == AOC_ENTRY)
     {
       std::istringstream iss(value);
       int val;
       iss >> val;
       setAttachOnCloningStatus((bool)val);
     }
   else if (name == TYPE_PROPERTY_STR)
     {
       if (value == SalomeContainerMonoHelper::TYPE_NAME)
         {
           _launchModeType->decrRef();
           _launchModeType=new SalomeContainerMonoHelper;
         }
       else if (value == SalomeContainerMultiHelper::TYPE_NAME)
         {
           _launchModeType->decrRef();
           _launchModeType=new SalomeContainerMultiHelper;
         }
       else
         throw Exception("SalomeContainer::setProperty : type value is not correct (mono or multi): " + value);
     }
   _sct.setProperty(name,value);
 }

References _launchModeType, _sct, YACS::ENGINE::Container::AOC_ENTRY, YACS::ENGINE::RefCounter::decrRef(), YACS::ENGINE::Container::setAttachOnCloningStatus(), YACS::ENGINE::SalomeContainerTools::setProperty(), YACS::ENGINE::SalomeContainerMonoHelper::TYPE_NAME, YACS::ENGINE::SalomeContainerMultiHelper::TYPE_NAME, and TYPE_PROPERTY_STR.

◆ shutdown()

void SalomeContainer::shutdown ( int level )

virtual

Implements YACS::ENGINE::Container.

Definition at line 252 of file SalomeContainer.cxx.

 {
   DEBTRACE("SalomeContainer::shutdown: " << _name << "," << level << "," << _shutdownLevel);
   if(level < _shutdownLevel)
     return;
  
   _shutdownLevel=999;
   //shutdown the SALOME containers
   _launchModeType->shutdown();
 }

References _launchModeType, YACS::ENGINE::Container::_name, _shutdownLevel, DEBTRACE, and YACS::ENGINE::SalomeContainerHelper::shutdown().

◆ start() [1/2]

void SalomeContainer::start ( const Task * askingNode )

overridevirtual

Start a salome container (true salome container not yacs one) with given ContainerParameters (_params)

Parameters

inst	the component instance

Implements YACS::ENGINE::Container.

Definition at line 223 of file SalomeContainer.cxx.

 {
   SalomeContainerTools::Start(_componentNames,_launchModeType,_sct,_shutdownLevel,this,askingNode);
 }

References _componentNames, _launchModeType, _sct, _shutdownLevel, and YACS::ENGINE::SalomeContainerToolsBase::Start().

Referenced by YACS::ENGINE::SalomeContainerTmpForHP::loadComponent(), and start().

◆ start() [2/2]

void SalomeContainer::start	(	const Task *	askingNode,
		const std::string &	resource_name,
		const std::string &	container_name
	)

overridevirtual

Reimplemented from YACS::ENGINE::Container.

Definition at line 228 of file SalomeContainer.cxx.

 {
   if(canAcceptImposedResource()
     && askingNode != nullptr
     && askingNode->hasImposedResource())
   {
     SalomeContainerTools tempSct = _sct;
     tempSct.setProperty("name", resource_name);
     tempSct.setProperty("container_name", container_name);
     // components are not supported yet on this kind of start
     std::vector<std::string> noComponentNames;
     SalomeContainerTools::Start(noComponentNames,_launchModeType,tempSct,_shutdownLevel,this,askingNode);
   }
   else
     start(askingNode);
 }

References _launchModeType, _sct, _shutdownLevel, canAcceptImposedResource(), YACS::ENGINE::Task::hasImposedResource(), YACS::ENGINE::SalomeContainerTools::setProperty(), YACS::ENGINE::SalomeContainerToolsBase::Start(), and start().

◆ unLock()

void SalomeContainer::unLock ( )

virtual

For thread safety for concurrent load operation on same Container.

Implements YACS::ENGINE::Container.

Definition at line 88 of file SalomeContainer.cxx.

 {
   _mutex.unLock();
 }

References _mutex.

Friends And Related Function Documentation

◆ SalomeComponent

friend class SalomeComponent

friend

Definition at line 40 of file SalomeContainer.hxx.

Member Data Documentation

◆ _componentNames

std::vector<std::string> YACS::ENGINE::SalomeContainer::_componentNames

protected

Definition at line 83 of file SalomeContainer.hxx.

Referenced by addComponentName(), and start().

◆ _launchModeType

SalomeContainerHelper* YACS::ENGINE::SalomeContainer::_launchModeType

protected

Definition at line 84 of file SalomeContainer.hxx.

Referenced by canAcceptImposedResource(), getContainerPtr(), getFullPlacementId(), getPlacementId(), getProperty(), isAlreadyStarted(), loadComponent(), YACS::ENGINE::SalomeContainerTmpForHP::loadComponent(), setProperty(), shutdown(), start(), and ~SalomeContainer().

◆ _mutex

YACS::BASES::Mutex YACS::ENGINE::SalomeContainer::_mutex

protected

thread safety in Salome ???

Definition at line 82 of file SalomeContainer.hxx.

Referenced by lock(), and unLock().

◆ _sct

SalomeContainerTools YACS::ENGINE::SalomeContainer::_sct

protected

Definition at line 86 of file SalomeContainer.hxx.

Referenced by addToResourceList(), clearProperties(), getProperties(), getProperty(), getResourceProperties(), setProperty(), and start().

◆ _shutdownLevel

int YACS::ENGINE::SalomeContainer::_shutdownLevel

protected

Definition at line 85 of file SalomeContainer.hxx.

Referenced by shutdown(), and start().

◆ KIND

const char SalomeContainer::KIND ="Salome"

static

Definition at line 74 of file SalomeContainer.hxx.

Referenced by getKind().

◆ TYPE_PROPERTY_STR

const char SalomeContainer::TYPE_PROPERTY_STR ="type"

static

Definition at line 75 of file SalomeContainer.hxx.

Referenced by getProperty(), and setProperty().

The documentation for this class was generated from the following files:

src/runtime/SalomeContainer.hxx
src/runtime/SalomeContainer.cxx

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SalomeContainer() [1/3]

◆ SalomeContainer() [2/3]

◆ SalomeContainer() [3/3]

◆ ~SalomeContainer()

Member Function Documentation

◆ addComponentName()

◆ addToResourceList()

◆ canAcceptImposedResource()

◆ checkCapabilityToDealWith()

◆ clearProperties()

◆ clone()

◆ cloneAlways()

◆ getContainerPtr()

◆ getFullPlacementId()

◆ getKind()

◆ getPlacementId()

◆ getProperties()

◆ getProperty()

◆ getResourceProperties()

◆ isAlreadyStarted()

◆ loadComponent()

◆ lock()

◆ setProperty()

◆ shutdown()

◆ start() [1/2]

◆ start() [2/2]

◆ unLock()

Friends And Related Function Documentation

◆ SalomeComponent

Member Data Documentation

◆ _componentNames

◆ _launchModeType

◆ _mutex

◆ _sct

◆ _shutdownLevel

◆ KIND

◆ TYPE_PROPERTY_STR