YACS::ENGINE::Container Class Reference

#include <Container.hxx>

Inheritance diagram for YACS::ENGINE::Container:

Collaboration diagram for YACS::ENGINE::Container:

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

Static Public Attributes
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
	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 ( )

protected

Definition at line 35 of file Container.cxx.

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

Container::~Container ( )

protectedvirtual

Definition at line 39 of file Container.cxx.

{
}

Member Function Documentation

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

pure virtual

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

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

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 62 of file Container.cxx.

References _isAttachedOnCloning.

{
  _isAttachedOnCloning=true;
}

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

pure virtual

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

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

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

pure virtual

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

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::CppContainer, YACS::ENGINE::SalomeHPContainer, and YACS::ENGINE::SalomeContainer.

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

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

pure virtual

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

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

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 70 of file Container.cxx.

References _isAttachedOnCloning.

{
  _isAttachedOnCloning=false;
}

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

virtual

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

Definition at line 43 of file Container.cxx.

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

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

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

pure virtual

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

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

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

pure virtual

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

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

inline

Definition at line 75 of file Container.hxx.

Referenced by YACS::HMI::SchemaDirContainersItem::addComponentItem(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::HMI::GuiEditor::CreateComponentInstance(), YACS::HMI::EditionComponent::fillContainerPanel(), YACS::HMI::EditionScript::fillContainerPanel(), YACS::HMI::EditionSalomeNode::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(), and YACS::ENGINE::VisitorSaveSchema::writeComponentInstances().

{ return _name; }

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

pure virtual

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

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

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

inline

Definition at line 79 of file Container.hxx.

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

{ return _proc; }

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

pure virtual

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

Referenced by FormContainerBase::FillPanel(), FormAdvParamContainer::FillPanel(), YACS::HMI::SubjectContainerBase::getProperties(), YACS::HMI::CommandAddContainerBase::localExecute(), YACS::HMI::CommandSetContainerProperties::localExecute(), FormAdvParamContainer::onModifyClock(), FormAdvParamContainer::onModifyCompoList(), FormAdvParamContainer::onModifyCompos(), FormAdvParamContainer::onModifyContName(), FormAdvParamContainer::onModifyHostName(), FormAdvParamContainer::onModifyIsMPI(), FormAdvParamContainer::onModifyMem(), FormAdvParamContainer::onModifyNodes(), FormAdvParamContainer::onModifyOS(), FormAdvParamContainer::onModifyParLib(), FormAdvParamContainer::onModifyPolicy(), FormAdvParamContainer::onModifyProcPar(), FormAdvParamContainer::onModifyProcRes(), FormAdvParamContainer::onModifyProcs(), FormAdvParamContainer::onModifyResource(), FormAdvParamContainer::onModifyResourceList(), FormAdvParamContainer::onModifyResourceName(), FormHPContainer::onModifySzOfPool(), and FormAdvParamContainer::onModifyWorkDir().

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

pure virtual

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

Referenced by FormContainer::onModifyType().

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

pure virtual

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

Referenced by FormAdvParamContainer::updateResource().

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

pure virtual

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

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

bool Container::isAttachedOnCloning ( ) const

virtual

Reimplemented in YACS::ENGINE::HomogeneousPoolContainer.

Definition at line 75 of file Container.cxx.

References _isAttachedOnCloning.

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

{
  return _isAttachedOnCloning;
}

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 84 of file Container.cxx.

{
  return true;
}

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

pure virtual

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

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 54 of file Container.cxx.

References _isAttachedOnCloning.

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

{
  _isAttachedOnCloning=val;
}

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 77 of file Container.hxx.

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

{ _name = name; }

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

inline

Definition at line 78 of file Container.hxx.

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

{ _proc = proc; }

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

virtual

Definition at line 89 of file Container.cxx.

References setProperty().

Referenced by YACS::HMI::CommandAddContainerBase::localExecute(), YACS::HMI::CommandSetContainerProperties::localExecute(), and YACS::HMI::CommandSetContainerProperties::localReverse().

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

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

pure virtual

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

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

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

pure virtual

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

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

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

pure virtual

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

Referenced by YACS::ENGINE::SalomePythonComponent::load(), YACS::ENGINE::ServerNode::load(), YACS::ENGINE::CppComponent::load(), and YACS::ENGINE::SalomeContainerTools::LoadComponent().

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

pure virtual

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

Member Data Documentation

bool YACS::ENGINE::Container::_isAttachedOnCloning

mutableprotected

Definition at line 85 of file Container.hxx.

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

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

protected

Definition at line 84 of file Container.hxx.

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

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

protected

Definition at line 86 of file Container.hxx.

const char Container::AOC_ENTRY ="attached_on_cloning"

static

Definition at line 82 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().

const char Container::KIND_ENTRY ="container_kind"

static

Definition at line 81 of file Container.hxx.

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

---

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

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