#include <Container.hxx>

Inheritance diagram for YACS::ENGINE::Container:

[legend]

Collaboration diagram for YACS::ENGINE::Container:

[legend]

Public Member Functions
virtual std::string	getKind () const =0

virtual std::string	getDiscreminantStrOfThis (const Task *askingNode) const

virtual bool	isAlreadyStarted (const Task *askingNode) const =0

virtual void	start (const Task *askingNode)=0

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

virtual bool	canAcceptImposedResource ()

virtual bool	isUsingPythonCache ()

virtual void	usePythonCache (bool v)

virtual std::string	getPlacementId (const Task *askingNode) const =0

virtual std::string	getFullPlacementId (const Task *askingNode) const =0

virtual void	setAttachOnCloningStatus (bool val) const

virtual void	attachOnCloning () const

virtual void	dettachOnCloning () const

virtual bool	isAttachedOnCloning () const

virtual void	lock ()=0

virtual void	unLock ()=0

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

virtual Container *	cloneAlways () const =0

virtual bool	isSupportingRTODefNbOfComp () const

virtual void	checkCapabilityToDealWith (const ComponentInstance *inst) const =0

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

virtual std::string	getProperty (const std::string &name) const =0

virtual void	clearProperties ()=0

virtual void	addComponentName (const std::string &name)=0

virtual std::map< std::string, std::string >	getProperties () const =0

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

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

virtual void	shutdown (int level)=0

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

virtual	~Container ()

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

	RefCounter (const RefCounter &other)

virtual	~RefCounter ()

Protected Attributes
std::string	_name

bool	_isAttachedOnCloning

Proc *	_proc

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

Detailed Description

This is an abstract class, that represents an abstract process in which ComponentInstances can be launched and run. An instance of this will be mapped to one and only one physical container (except in the foreach context)

Definition at line 41 of file Container.hxx.

Constructor & Destructor Documentation

◆ Container()

Container::Container ( )

protected

Definition at line 37 of file Container.cxx.

                     :_isAttachedOnCloning(false),_proc(0)
 {
 }

◆ ~Container()

Container::~Container ( )

protectedvirtual

Definition at line 41 of file Container.cxx.

42 {

43 }

Member Function Documentation

◆ addComponentName()

virtual void YACS::ENGINE::Container::addComponentName ( const std::string & name )

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::SalomeComponent::setContainer(), and YACS::ENGINE::SalomeHPComponent::setContainer().

◆ attachOnCloning()

void Container::attachOnCloning ( ) const

virtual

By calling this method the current container 'this' is not destined to be deeply copied on clone call.

Reimplemented in YACS::ENGINE::HomogeneousPoolContainer.

Definition at line 76 of file Container.cxx.

 {
   _isAttachedOnCloning=true;
 }

References _isAttachedOnCloning.

◆ canAcceptImposedResource()

bool Container::canAcceptImposedResource ( )

virtual

Reimplemented in YACS::ENGINE::SalomeContainer.

Definition at line 59 of file Container.cxx.

 {
   return false;
 }

Referenced by YACS::ENGINE::PythonNode::canAcceptImposedResource(), and YACS::ENGINE::PyFuncNode::canAcceptImposedResource().

◆ checkCapabilityToDealWith()

virtual void YACS::ENGINE::Container::checkCapabilityToDealWith ( const ComponentInstance * inst ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::ComponentInstance::setContainer().

◆ clearProperties()

virtual void YACS::ENGINE::Container::clearProperties ( )

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

◆ clone()

virtual Container* YACS::ENGINE::Container::clone ( ) const

pure virtual

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

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::ENGINE::ComponentInstance::ComponentInstance(), YACS::ENGINE::ComposedNode::performDuplicationOfPlacement(), and YACS::ENGINE::InlineNode::performDuplicationOfPlacement().

◆ cloneAlways()

virtual Container* YACS::ENGINE::Container::cloneAlways ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::HMI::SubjectServiceNode::setComponent().

◆ dettachOnCloning()

void Container::dettachOnCloning ( ) const

virtual

By calling this method the current container 'this' will be deeply copied on clone call.

Reimplemented in YACS::ENGINE::HomogeneousPoolContainer.

Definition at line 84 of file Container.cxx.

 {
   _isAttachedOnCloning=false;
 }

References _isAttachedOnCloning.

◆ getDiscreminantStrOfThis()

std::string Container::getDiscreminantStrOfThis ( const Task * askingNode ) const

virtual

Reimplemented in YACS::ENGINE::SalomeHPContainer, and YACS::ENGINE::SalomeContainerTmpForHP.

Definition at line 45 of file Container.cxx.

 {
   const void *ptr(this);
   std::ostringstream oss; oss << ptr;
   return oss.str();
 }

Referenced by YACS::ENGINE::SalomeContainerTools::getNotNullContainerName().

◆ getFullPlacementId()

virtual std::string YACS::ENGINE::Container::getFullPlacementId ( const Task * askingNode ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::Executor::ComputePlacement().

◆ getKind()

virtual std::string YACS::ENGINE::Container::getKind ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

◆ getName()

virtual std::string YACS::ENGINE::Container::getName ( ) const

inlinevirtual

Definition at line 81 of file Container.hxx.

81 { return _name; }

YACS::ENGINE::Container::_name

std::string _name

Definition: Container.hxx:91

Referenced by YACS::HMI::SchemaDirContainersItem::addComponentItem(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::HMI::GuiEditor::CreateComponentInstance(), YACS::HMI::EditionComponent::fillContainerPanel(), YACS::HMI::EditionSalomeNode::fillContainerPanel(), YACS::HMI::EditionScript::fillContainerPanel(), FormContainerBase::FillPanel(), YACS::HMI::SubjectContainerBase::getName(), YACS::ENGINE::SalomeContainerTools::getNotNullContainerName(), YACS::HMI::CommandAssociateComponentToContainer::localExecute(), YACS::HMI::CommandAssociateServiceToComponent::localExecute(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::ENGINE::Proc::removeContainer(), YACS::HMI::SubjectServiceNode::setComponent(), YACS::HMI::SubjectComponent::setContainer(), YACS::ENGINE::Executor::traceExec(), YACS::ENGINE::Proc::updateContainersAndComponents(), YACS::ENGINE::VisitorSaveSchema::visitInlineFuncNode(), YACS::ENGINE::VisitorSaveSchema::visitInlineNode(), YACS::ENGINE::WlmTask::WlmTask(), and YACS::ENGINE::VisitorSaveSchema::writeComponentInstances().

◆ getPlacementId()

virtual std::string YACS::ENGINE::Container::getPlacementId ( const Task * askingNode ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::SalomePythonComponent::getStringValueToExportInInterp().

◆ getProc()

Proc* YACS::ENGINE::Container::getProc ( )

inline

Definition at line 85 of file Container.hxx.

85 { return _proc; }

References driver_internal::_proc.

Referenced by YACS::ENGINE::SalomeContainerToolsBase::CreateComponentInstance().

◆ getProperties()

virtual std::map<std::string,std::string> YACS::ENGINE::Container::getProperties ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

◆ getProperty()

virtual std::string YACS::ENGINE::Container::getProperty ( const std::string & name ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::WlmTask::isAccepted(), isUsingPythonCache(), YACS::ENGINE::PythonEntry::loadRemoteContext(), FormContainer::onModifyType(), and YACS::ENGINE::WlmTask::WlmTask().

◆ getResourceProperties()

virtual std::map<std::string,std::string> YACS::ENGINE::Container::getResourceProperties ( const std::string & name ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by FormAdvParamContainer::updateResource().

◆ isAlreadyStarted()

virtual bool YACS::ENGINE::Container::isAlreadyStarted ( const Task * askingNode ) const

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::SalomeContainerToolsBase::GetFullPlacementId(), YACS::ENGINE::SalomeContainerToolsBase::GetPlacementId(), YACS::ENGINE::SalomePythonComponent::isLoaded(), YACS::ENGINE::ServerNode::load(), YACS::ENGINE::DistributedPythonNode::load(), YACS::ENGINE::CppComponent::load(), YACS::ENGINE::SalomeContainerToolsBase::LoadComponent(), and YACS::ENGINE::PythonEntry::loadRemoteContainer().

◆ isAttachedOnCloning()

bool Container::isAttachedOnCloning ( ) const

virtual

Reimplemented in YACS::ENGINE::HomogeneousPoolContainer.

Definition at line 89 of file Container.cxx.

 {
   return _isAttachedOnCloning;
 }

References _isAttachedOnCloning.

Referenced by FormContainer::FillPanel(), YACS::ENGINE::DeploymentTreeOnHeap::getAllCTDefContainers(), YACS::ENGINE::DeploymentTreeOnHeap::getAllRTODefContainers(), YACS::ENGINE::DeploymentTreeOnHeap::getNumberOfCTDefContainer(), and FormContainer::onModifyAOC().

◆ isSupportingRTODefNbOfComp()

bool Container::isSupportingRTODefNbOfComp ( ) const

virtual

This method informs about the capability of the container to deal with CT an unpredictably number of components. By default : True

Definition at line 98 of file Container.cxx.

 {
   return true;
 }

◆ isUsingPythonCache()

bool Container::isUsingPythonCache ( )

virtual

Definition at line 109 of file Container.cxx.

 {
   bool found = false;
   std::string str_value;
   str_value = getProperty(USE_PYCACHE_PROPERTY);
   const char* yes_values[] = {"YES", "Yes", "yes", "TRUE", "True", "true", "1",
                               "ON", "on", "On"};
   for(const char* v : yes_values)
     if(str_value == v)
     {
       found = true;
       break;
     }
   return found;
 }

References getProperty(), and USE_PYCACHE_PROPERTY.

Referenced by FormAdvParamContainer::FillPanel(), YACS::ENGINE::PythonNode::isUsingPythonCache(), and FormAdvParamContainer::onModifyUsePyCache().

◆ lock()

virtual void YACS::ENGINE::Container::lock ( )

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

◆ setAttachOnCloningStatus()

void Container::setAttachOnCloningStatus ( bool val ) const

virtual

If val is equal to true the current container 'this' is not destined to be deeply copied on clone call. If val is equal to false the current container 'this' is destined to be deeply copied on clone call.

Reimplemented in YACS::ENGINE::HomogeneousPoolContainer.

Definition at line 68 of file Container.cxx.

 {
   _isAttachedOnCloning=val;
 }

References _isAttachedOnCloning.

Referenced by FormContainer::onModifyAOC(), and YACS::ENGINE::SalomeContainer::setProperty().

◆ setName()

void YACS::ENGINE::Container::setName ( std::string name )

inline

WARNING ! name is used in edition to identify different containers, it is not the runtime name of the container

Definition at line 83 of file Container.hxx.

83 { _name = name; }

Referenced by YACS::ENGINE::Proc::createContainer(), YACS::servertypeParser< T >::loadcontainer(), YACS::HMI::CommandRenameContainer::localExecute(), YACS::HMI::CommandAddContainerBase::localExecute(), and YACS::HMI::CommandRenameContainer::localReverse().

◆ setProc()

void YACS::ENGINE::Container::setProc ( Proc * proc )

inline

Definition at line 84 of file Container.hxx.

84 { _proc = proc; }

References driver_internal::_proc.

Referenced by YACS::ENGINE::Proc::createContainer(), and YACS::HMI::CommandAddContainerBase::localExecute().

◆ setProperties()

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

virtual

Definition at line 103 of file Container.cxx.

 {
   for (std::map<std::string,std::string>::const_iterator it=properties.begin();it!=properties.end();++it)
     setProperty((*it).first,(*it).second);
 }

References setProperty().

Referenced by YACS::HMI::CommandAddContainerBase::localExecute().

◆ setProperty()

virtual void YACS::ENGINE::Container::setProperty	(	const std::string &	name,
		const std::string &	value
	)

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::proctypeParser< T >::container(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::SalomeProc::SalomeProc(), setProperties(), and usePythonCache().

◆ shutdown()

virtual void YACS::ENGINE::Container::shutdown ( int level )

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::PythonNode::shutdown(), YACS::ENGINE::PyFuncNode::shutdown(), YACS::ENGINE::SalomeComponent::shutdown(), and YACS::ENGINE::SalomeHPComponent::shutdown().

◆ start() [1/2]

virtual void YACS::ENGINE::Container::start ( const Task * askingNode )

pure virtual

Implemented in YACS::ENGINE::SalomeContainer, YACS::ENGINE::SalomeHPContainer, and YACS::ENGINE::CppContainer.

Referenced by YACS::ENGINE::ServerNode::load(), YACS::ENGINE::CppComponent::load(), YACS::ENGINE::SalomePythonComponent::load(), YACS::ENGINE::SalomeContainerToolsBase::LoadComponent(), YACS::ENGINE::PythonEntry::loadRemoteContainer(), and start().

◆ start() [2/2]

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

virtual

Reimplemented in YACS::ENGINE::SalomeContainer.

Definition at line 52 of file Container.cxx.

 {
   return start(askingNode);
 }

References start().

◆ unLock()

virtual void YACS::ENGINE::Container::unLock ( )

pure virtual

Implemented in YACS::ENGINE::SalomeHPContainer, YACS::ENGINE::SalomeContainer, and YACS::ENGINE::CppContainer.

◆ usePythonCache()

void Container::usePythonCache ( bool v )

virtual

Definition at line 125 of file Container.cxx.

 {
   if(v)
     setProperty(USE_PYCACHE_PROPERTY, "1");
   else
     setProperty(USE_PYCACHE_PROPERTY, "0");
 }

References setProperty(), and USE_PYCACHE_PROPERTY.

Referenced by FormAdvParamContainer::onModifyUsePyCache().

Member Data Documentation

◆ _isAttachedOnCloning

bool YACS::ENGINE::Container::_isAttachedOnCloning

mutableprotected

Definition at line 92 of file Container.hxx.

Referenced by attachOnCloning(), YACS::ENGINE::HomogeneousPoolContainer::attachOnCloning(), YACS::ENGINE::CppContainer::clone(), YACS::ENGINE::SalomeContainer::clone(), dettachOnCloning(), YACS::ENGINE::HomogeneousPoolContainer::dettachOnCloning(), YACS::ENGINE::SalomeContainer::getProperty(), YACS::ENGINE::HomogeneousPoolContainer::HomogeneousPoolContainer(), isAttachedOnCloning(), setAttachOnCloningStatus(), and YACS::ENGINE::HomogeneousPoolContainer::setAttachOnCloningStatus().

◆ _name

std::string YACS::ENGINE::Container::_name

protected

Definition at line 91 of file Container.hxx.

Referenced by YACS::ENGINE::SalomeContainer::shutdown().

◆ _proc

Proc* YACS::ENGINE::Container::_proc

protected

Definition at line 93 of file Container.hxx.

◆ AOC_ENTRY

const char Container::AOC_ENTRY ="attached_on_cloning"

static

Definition at line 88 of file Container.hxx.

Referenced by YACS::ENGINE::SalomeContainer::getProperty(), YACS::ENGINE::SalomeHPContainer::getProperty(), FormContainer::onModifyAOC(), YACS::ENGINE::SalomeContainer::setProperty(), YACS::ENGINE::SalomeHPContainer::setProperty(), and YACS::ENGINE::VisitorSaveSchema::writeContainers().

◆ KIND_ENTRY

const char Container::KIND_ENTRY ="container_kind"

static

Definition at line 87 of file Container.hxx.

Referenced by YACS::proctypeParser< T >::container(), and YACS::ENGINE::VisitorSaveSchema::writeContainers().

◆ USE_PYCACHE_PROPERTY

const char Container::USE_PYCACHE_PROPERTY ="use_py_cache"

static

Definition at line 89 of file Container.hxx.

Referenced by isUsingPythonCache(), and usePythonCache().

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

src/engine/Container.hxx
src/engine/Container.cxx

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Container()

◆ ~Container()

Member Function Documentation

◆ addComponentName()

◆ attachOnCloning()

◆ canAcceptImposedResource()

◆ checkCapabilityToDealWith()

◆ clearProperties()

◆ clone()

◆ cloneAlways()

◆ dettachOnCloning()

◆ getDiscreminantStrOfThis()

◆ getFullPlacementId()

◆ getKind()

◆ getName()

◆ getPlacementId()

◆ getProc()

◆ getProperties()

◆ getProperty()

◆ getResourceProperties()

◆ isAlreadyStarted()

◆ isAttachedOnCloning()

◆ isSupportingRTODefNbOfComp()

◆ isUsingPythonCache()

◆ lock()

◆ setAttachOnCloningStatus()

◆ setName()

◆ setProc()

◆ setProperties()

◆ setProperty()

◆ shutdown()

◆ start() [1/2]

◆ start() [2/2]

◆ unLock()

◆ usePythonCache()

Member Data Documentation

◆ _isAttachedOnCloning

◆ _name

◆ _proc

◆ AOC_ENTRY

◆ KIND_ENTRY

◆ USE_PYCACHE_PROPERTY