Base class for all component instances. More...

#include <ComponentInstance.hxx>

Inheritance diagram for YACS::ENGINE::ComponentInstance:

Collaboration diagram for YACS::ENGINE::ComponentInstance:

Public Member Functions
	ComponentInstance (const std::string &name)

	ComponentInstance (const ComponentInstance &other)

const std::string &	getCompoName () const

const std::string &	getInstanceName () const

void	setName (const std::string &name)

virtual void	setAnonymous (bool anon)

virtual bool	isAnonymous ()

int	getNumId () const

virtual bool	setContainer (Container *cont)

Container *	getContainer () const

virtual void	load (Task *askingNode)=0
	Load the component instance. More...

virtual void	unload (Task *askingNode)=0
	Unload the component instance. More...

virtual bool	isLoaded (Task *askingNode) const =0
	Indicate if the component instance is loaded (true) or not. More...

virtual void	attachOnCloning () const

virtual void	dettachOnCloning () const

bool	isAttachedOnCloning () const

virtual std::string	getFileRepr () const
	For dump in file. More...

virtual ServiceNode *	createNode (const std::string &name)=0

virtual ComponentInstance *	clone () const =0

virtual ComponentInstance *	cloneAlways () const =0

virtual std::string	getKind () const
	Return the component kind. More...

virtual std::string	getKindForNode () const

virtual void	shutdown (int level)

Public Member Functions inherited from YACS::ENGINE::PropertyInterface
virtual	~PropertyInterface ()

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

virtual std::string	getProperty (const std::string &name)
	Get a property value given its name. More...

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

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

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

void	incrRef () const

bool	decrRef ()

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

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

Protected Member Functions
virtual	~ComponentInstance ()

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

	RefCounter (const RefCounter &other)

virtual	~RefCounter ()

Protected Attributes
std::string	_compoName
	WARNING : _compoName identify only the component type. More...

std::string	_instanceName
	WARNING : _InstanceName has a strong semantic. It discriminates ComponentInstance instances each other. More...

int	_numId

Container *	_container

bool	_isAttachedOnCloning

bool	_anonymous

Protected Attributes inherited from YACS::ENGINE::PropertyInterface
std::map< std::string, std::string >	_propertyMap

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

Static Protected Attributes
static const char	NULL_FILE_REPR [] ="No repr specified for ComponentInstance"

static int	_total = 0

Detailed Description

Base class for all component instances.

This is an abstract class that must be specialized in runtime. Specialized classes must provide implementation for loading of a component (load method) unloading (unload method) and an information method (isLoaded) about the state of the component

A component instance is used by one or more ServiceNode to execute services of this component instance

See Also: ServiceNode

Definition at line 38 of file ComponentInstance.hxx.

Constructor & Destructor Documentation

ComponentInstance::~ComponentInstance ( )

protectedvirtual

Definition at line 87 of file ComponentInstance.cxx.

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

 {
   if(_container)
     _container->decrRef();
 }

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

Definition at line 66 of file ComponentInstance.cxx.

References _compoName, _instanceName, _numId, and _total.

                                                          :_compoName(name),_isAttachedOnCloning(false),_container(0),_anonymous(true)
 {
   _numId = _total++;
   stringstream instName;
   instName << _compoName << "_" << _numId;
   _instanceName = instName.str();
 }

ComponentInstance::ComponentInstance ( const ComponentInstance & other )

Definition at line 74 of file ComponentInstance.cxx.

References _compoName, _container, _instanceName, _numId, _total, and YACS::ENGINE::Container::clone().

                                                                   :_compoName(other._compoName),
                                                                      _container(0),
                                                                      _isAttachedOnCloning(other._isAttachedOnCloning),
                                                                      _anonymous(true)
 {
   _numId = _total++;
   stringstream instName;
   instName << _compoName << "_" << _numId;
   _instanceName = instName.str();
   if(other._container)
     _container=other._container->clone();
 }

Member Function Documentation

void ComponentInstance::attachOnCloning ( ) const

virtual

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

Definition at line 96 of file ComponentInstance.cxx.

References _isAttachedOnCloning.

 {
   _isAttachedOnCloning=true;
 }

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

pure virtual

Implemented in YACS::ENGINE::CppComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

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

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

pure virtual

Implemented in YACS::ENGINE::CppComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

Referenced by YACS::HMI::CommandAssociateServiceToComponent::localReverse().

virtual ServiceNode* YACS::ENGINE::ComponentInstance::createNode ( const std::string & name )

pure virtual

Implemented in YACS::ENGINE::CppComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomePythonComponent, and YACS::ENGINE::SalomeHPComponent.

void ComponentInstance::dettachOnCloning ( ) const

virtual

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

Definition at line 110 of file ComponentInstance.cxx.

References _isAttachedOnCloning.

 {
   _isAttachedOnCloning=false;
 }

const std::string& YACS::ENGINE::ComponentInstance::getCompoName ( ) const

inline

Definition at line 45 of file ComponentInstance.hxx.

Referenced by YACS::ENGINE::Proc::addComponentInstance(), YACS::ENGINE::SalomeContainerTools::CreateComponentInstance(), YACS::HMI::GuiEditor::CreateComponentInstance(), YACS::HMI::EditionSalomeNode::fillComponentPanel(), YACS::ENGINE::SalomeHPComponent::getFileRepr(), YACS::ENGINE::CORBAComponent::getFileRepr(), YACS::ENGINE::SalomeComponent::getFileRepr(), YACS::HMI::SubjectComponent::getKey(), YACS::ENGINE::CORBAComponent::load(), YACS::HMI::CommandAddNodeFromCatalog::localExecute(), YACS::HMI::GenericGui::onSelectComponentInstance(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::ENGINE::ServiceNode::setComponent(), YACS::HMI::SubjectServiceNode::setComponent(), YACS::ENGINE::LocalContainer::unregisterComponentInstance(), YACS::ENGINE::Proc::updateContainersAndComponents(), and YACS::ENGINE::VisitorSaveSchema::writeComponentInstances().

45 { return _compoName; }

Container* YACS::ENGINE::ComponentInstance::getContainer ( ) const

inline

Definition at line 52 of file ComponentInstance.hxx.

Referenced by YACS::HMI::SchemaDirContainersItem::addComponentItem(), YACS::HMI::EditionSalomeNode::changeContainer(), YACS::HMI::GuiEditor::CreateComponentInstance(), YACS::HMI::EditionComponent::fillContainerPanel(), YACS::HMI::EditionSalomeNode::fillContainerPanel(), YACS::ENGINE::DeploymentTreeOnHeap::getComponentsLinkedToContainer(), YACS::ENGINE::ServiceNode::getContainer(), YACS::HMI::SubjectComponent::localclean(), YACS::HMI::CommandAssociateComponentToContainer::localExecute(), YACS::HMI::CommandAssociateServiceToComponent::localExecute(), YACS::HMI::EditionSalomeNode::onCancel(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::HMI::SubjectServiceNode::setComponent(), YACS::HMI::SubjectComponent::setContainer(), YACS::ENGINE::VisitorSaveSchema::visitServiceNode(), and YACS::ENGINE::VisitorSaveSchema::writeComponentInstances().

52 { return _container; }

std::string ComponentInstance::getFileRepr ( ) const

virtual

For dump in file.

Reimplemented in YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

Definition at line 102 of file ComponentInstance.cxx.

References NULL_FILE_REPR.

Referenced by YACS::ENGINE::VisitorSaveSchema::visitServiceInlineNode(), and YACS::ENGINE::VisitorSaveSchema::visitServiceNode().

 {
   return NULL_FILE_REPR;
 }

const std::string& YACS::ENGINE::ComponentInstance::getInstanceName ( ) const

inline

Definition at line 46 of file ComponentInstance.hxx.

Referenced by YACS::HMI::SubjectProc::addSubjectComponent(), YACS::HMI::SubjectComponent::associateToContainer(), YACS::HMI::EditionSalomeNode::fillComponentPanel(), YACS::HMI::SubjectComponent::getName(), YACS::HMI::CommandAddNodeFromCatalog::localExecute(), YACS::HMI::CommandAddComponentInstance::localExecute(), YACS::HMI::CommandAddComponentFromCatalog::localExecute(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::ENGINE::Proc::removeComponentInstance(), YACS::HMI::SubjectServiceNode::setComponent(), YACS::ENGINE::VisitorSaveSchema::visitServiceNode(), YACS::ENGINE::VisitorSaveSchema::writeComponentInstances(), and YACS::HMI::SubjectComponent::~SubjectComponent().

46 { return _instanceName; }

string ComponentInstance::getKind ( ) const

virtual

Return the component kind.

A runtime can provide several implementations of a component instance. Each implementation has a different kind. A ComponentInstance can be associated to a ServiceNode is they have the same kind.

Reimplemented in YACS::ENGINE::CppComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

Definition at line 126 of file ComponentInstance.cxx.

References KIND.

 {
   return KIND;
 }

std::string ComponentInstance::getKindForNode ( ) const

virtual

Reimplemented in YACS::ENGINE::CppComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::CORBAComponent, and YACS::ENGINE::SalomeHPComponent.

Definition at line 131 of file ComponentInstance.cxx.

References KIND.

 {
   return KIND;
 }

int YACS::ENGINE::ComponentInstance::getNumId ( ) const

inline

Definition at line 50 of file ComponentInstance.hxx.

Referenced by YACS::HMI::SubjectComponent::getKey().

50 { return _numId; }

virtual bool YACS::ENGINE::ComponentInstance::isAnonymous ( )

inlinevirtual

Definition at line 49 of file ComponentInstance.hxx.

Referenced by YACS::HMI::CommandSetComponentInstanceProperties::localExecute(), YACS::ENGINE::VisitorSaveSchema::visitServiceNode(), and YACS::ENGINE::VisitorSaveSchema::writeComponentInstances().

49 { return _anonymous; };

bool ComponentInstance::isAttachedOnCloning ( ) const

Definition at line 115 of file ComponentInstance.cxx.

References _isAttachedOnCloning.

 {
   return _isAttachedOnCloning;
 }

virtual bool YACS::ENGINE::ComponentInstance::isLoaded ( Task * askingNode ) const

pure virtual

Indicate if the component instance is loaded (true) or not.

Implemented in YACS::ENGINE::CppComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

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

virtual void YACS::ENGINE::ComponentInstance::load ( Task * askingNode )

pure virtual

Load the component instance.

Implemented in YACS::ENGINE::CppComponent, YACS::ENGINE::CORBAComponent, YACS::ENGINE::SalomeComponent, YACS::ENGINE::SalomeHPComponent, and YACS::ENGINE::SalomePythonComponent.

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

virtual void YACS::ENGINE::ComponentInstance::setAnonymous ( bool anon )

inlinevirtual

Definition at line 48 of file ComponentInstance.hxx.

Referenced by YACS::ENGINE::Proc::addComponentInstance(), YACS::HMI::CommandSetComponentInstanceProperties::localExecute(), and YACS::HMI::CommandSetComponentInstanceProperties::localReverse().

48 { _anonymous = anon; };

bool ComponentInstance::setContainer ( Container * cont )

virtual

Reimplemented in YACS::ENGINE::SalomeComponent, and YACS::ENGINE::SalomeHPComponent.

Definition at line 52 of file ComponentInstance.cxx.

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

Referenced by YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::proctypeParser< T >::componentinstance(), YACS::HMI::CommandAddComponentInstance::localExecute(), YACS::HMI::CommandAssociateComponentToContainer::localExecute(), YACS::HMI::CommandAssociateComponentToContainer::localReverse(), YACS::HMI::CommandAssociateServiceToComponent::localReverse(), YACS::ENGINE::ComposedNode::performDuplicationOfPlacement(), YACS::ENGINE::ComposedNode::performShallowDuplicationOfPlacement(), YACS::HMI::SubjectServiceNode::setComponent(), YACS::ENGINE::SalomeHPComponent::setContainer(), and YACS::ENGINE::SalomeComponent::setContainer().

 {
   if (cont == _container) return false;
   
   if(cont)
     cont->checkCapabilityToDealWith(this);
   if(_container)
     _container->decrRef();
   _container=cont;
   if(_container)
     _container->incrRef();
   return true;
 }