#include <SalomeContainer.hxx>

Inheritance diagram for YACS::ENGINE::SalomeContainer:

Collaboration diagram for YACS::ENGINE::SalomeContainer:

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) throw (Exception)
	Start a salome container (true salome container not yacs one) with given ContainerParameters (_params) More...

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 throw (Exception)

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

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

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 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::SalomeContainer ( )

Definition at line 59 of file SalomeContainer.cxx.

Referenced by clone(), and cloneAlways().

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

SalomeContainer::SalomeContainer ( const SalomeContainer & other )

Definition at line 63 of file SalomeContainer.cxx.

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

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

Definition at line 71 of file SalomeContainer.cxx.

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

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

SalomeContainer::~SalomeContainer ( )

protectedvirtual

Definition at line 79 of file SalomeContainer.cxx.

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

 {
   _launchModeType->decrRef();
 }

Member Function Documentation

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 166 of file SalomeContainer.cxx.

References _componentNames.

 {
   _componentNames.push_back(name);
 }

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

Definition at line 171 of file SalomeContainer.cxx.

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

 {
   _sct.addToResourceList(name);
 }

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 115 of file SalomeContainer.cxx.

References YACS::ENGINE::SalomeComponent::KIND.

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

void SalomeContainer::clearProperties ( )

virtual

Implements YACS::ENGINE::Container.

Definition at line 161 of file SalomeContainer.cxx.

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

 {
   _sct.clearProperties();
 }

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 99 of file SalomeContainer.cxx.

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

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

Container * SalomeContainer::cloneAlways ( ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 110 of file SalomeContainer.cxx.

References SalomeContainer().

 {
   return new SalomeContainer(*this);
 }

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

Definition at line 215 of file SalomeContainer.cxx.

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

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

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

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 200 of file SalomeContainer.cxx.

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

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

std::string SalomeContainer::getKind ( ) const

virtual

Implements YACS::ENGINE::Container.

Definition at line 94 of file SalomeContainer.cxx.

References KIND.

 {
   return KIND;
 }

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 190 of file SalomeContainer.cxx.

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

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

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 245 of file SalomeContainer.cxx.

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

 {
   return _sct.getProperties();
 }

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 148 of file SalomeContainer.cxx.

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

 {
   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);
 }

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 240 of file SalomeContainer.cxx.

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

 {
   return _sct.getResourceProperties(name);
 }

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 210 of file SalomeContainer.cxx.

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

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

 {
   return _launchModeType->isAlreadyStarted(askingNode);
 }

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 180 of file SalomeContainer.cxx.

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

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

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

void SalomeContainer::lock ( )

virtual

For thread safety for concurrent load operation on same Container.

Implements YACS::ENGINE::Container.

Definition at line 84 of file SalomeContainer.cxx.

References _mutex.

 {
   _mutex.lock();
 }

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

virtual

Implements YACS::ENGINE::Container.

Definition at line 121 of file SalomeContainer.cxx.

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.

 {
   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);
 }

void SalomeContainer::shutdown ( int level )

virtual

Implements YACS::ENGINE::Container.

Definition at line 229 of file SalomeContainer.cxx.

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

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

void SalomeContainer::start ( const Task * askingNode ) throw (Exception)

virtual

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 224 of file SalomeContainer.cxx.

References YACS::ENGINE::SalomeContainerTools::Start().

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

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

void SalomeContainer::unLock ( )

virtual

For thread safety for concurrent load operation on same Container.

Implements YACS::ENGINE::Container.

Definition at line 89 of file SalomeContainer.cxx.

References _mutex.

 {
   _mutex.unLock();
 }

Friends And Related Function Documentation

friend class SalomeComponent

friend

Definition at line 40 of file SalomeContainer.hxx.

Member Data Documentation

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

protected

Definition at line 79 of file SalomeContainer.hxx.

Referenced by addComponentName().

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

protected

Definition at line 80 of file SalomeContainer.hxx.

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

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

protected

thread safety in Salome ???

Definition at line 78 of file SalomeContainer.hxx.

Referenced by lock(), and unLock().

SalomeContainerTools YACS::ENGINE::SalomeContainer::_sct

protected

Definition at line 82 of file SalomeContainer.hxx.

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

int YACS::ENGINE::SalomeContainer::_shutdownLevel

protected

Definition at line 81 of file SalomeContainer.hxx.

Referenced by shutdown().

const char SalomeContainer::KIND ="Salome"

static

Definition at line 70 of file SalomeContainer.hxx.

Referenced by getKind().

const char SalomeContainer::TYPE_PROPERTY_STR ="type"

static

Definition at line 71 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

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation