Class for Salome component instance. More...

#include <SalomeComponent.hxx>

Inheritance diagram for YACS::ENGINE::SalomeComponent:

Collaboration diagram for YACS::ENGINE::SalomeComponent:

Public Member Functions
	SalomeComponent (const std::string &name)
	SalomeComponent constructor. More...

	SalomeComponent (const SalomeComponent &other)
	SalomeComponent copy constructor. More...

virtual	~SalomeComponent ()

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

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

virtual bool	isLoaded (Task *askingNode) const
	Is the component instance already loaded ? More...

virtual bool	setContainer (Container *cont)

virtual ServiceNode *	createNode (const std::string &name)
	Create a ServiceNode with this component instance and no input or output port. More...

virtual ComponentInstance *	clone () const
	Clone the component instance. More...

virtual ComponentInstance *	cloneAlways () const

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

virtual CORBA::Object_ptr	getCompoPtr ()

virtual void	shutdown (int level)

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

virtual std::string	getKindForNode () const

Public Member Functions inherited from YACS::ENGINE::ComponentInstance
	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

Container *	getContainer () const

virtual void	attachOnCloning () const

virtual void	dettachOnCloning () const

bool	isAttachedOnCloning () const

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 [] ="Salome"

Static Public Attributes inherited from YACS::ENGINE::ComponentInstance
static const char	KIND [] =""

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

Protected Attributes
CORBA::Object_var	_objComponent

Protected Attributes inherited from YACS::ENGINE::ComponentInstance
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

Additional Inherited Members
Protected Member Functions inherited from YACS::ENGINE::ComponentInstance
virtual	~ComponentInstance ()

Static Protected Attributes inherited from YACS::ENGINE::ComponentInstance
static const char	NULL_FILE_REPR [] ="No repr specified for ComponentInstance"

static int	_total = 0

Detailed Description

Class for Salome component instance.

Definition at line 35 of file SalomeComponent.hxx.

Constructor & Destructor Documentation

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

SalomeComponent constructor.

Definition at line 45 of file SalomeComponent.cxx.

References _objComponent.

Referenced by clone(), and cloneAlways().

                                                      : ComponentInstance(name)
 {
   _objComponent=CORBA::Object::_nil();
 }

SalomeComponent::SalomeComponent ( const SalomeComponent & other )

SalomeComponent copy constructor.

Definition at line 51 of file SalomeComponent.cxx.

References _objComponent.

                                                             :ComponentInstance(other)
 {
   _objComponent=CORBA::Object::_nil();
 }

SalomeComponent::~SalomeComponent ( )

virtual

Definition at line 56 of file SalomeComponent.cxx.

57 {

58 }

Member Function Documentation

ComponentInstance * SalomeComponent::clone ( ) const

virtual

Clone the component instance.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 130 of file SalomeComponent.cxx.

References YACS::ENGINE::ComponentInstance::_isAttachedOnCloning, YACS::ENGINE::RefCounter::incrRef(), and SalomeComponent().

 {
   if(_isAttachedOnCloning)
     {
       incrRef();
       return (ComponentInstance*) (this);
     }
   else
     return new SalomeComponent(*this);
 }

ComponentInstance * SalomeComponent::cloneAlways ( ) const

virtual

Implements YACS::ENGINE::ComponentInstance.

Definition at line 141 of file SalomeComponent.cxx.

References SalomeComponent().

 {
   return new SalomeComponent(*this);
 }

ServiceNode * SalomeComponent::createNode ( const std::string & name )

virtual

Create a ServiceNode with this component instance and no input or output port.

Parameters

name	: node name

Returns: a new SalomeNode node

Implements YACS::ENGINE::ComponentInstance.

Definition at line 122 of file SalomeComponent.cxx.

References YACS::ENGINE::ServiceNode::setComponent().

 {
    SalomeNode* node=new SalomeNode(name);
    node->setComponent(this);
    return node;
 }

virtual CORBA::Object_ptr YACS::ENGINE::SalomeComponent::getCompoPtr ( )

inlinevirtual

Definition at line 49 of file SalomeComponent.hxx.

49 {return CORBA::Object::_duplicate(_objComponent);}

std::string SalomeComponent::getFileRepr ( ) const

virtual

For dump in file.

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 146 of file SalomeComponent.cxx.

References YACS::ENGINE::ComponentInstance::getCompoName().

 {
   ostringstream stream;
   stream << "<component>" << getCompoName() << "</component>";
   return stream.str();
 }

std::string SalomeComponent::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 from YACS::ENGINE::ComponentInstance.

Definition at line 60 of file SalomeComponent.cxx.

References KIND.

 {
   return KIND;
 }

std::string SalomeComponent::getKindForNode ( ) const

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 65 of file SalomeComponent.cxx.

References KIND.

 {
   return KIND;
 }

bool SalomeComponent::isLoaded ( Task * askingNode ) const

virtual

Is the component instance already loaded ?

Implements YACS::ENGINE::ComponentInstance.

Definition at line 78 of file SalomeComponent.cxx.

References _objComponent.

 {
   if(CORBA::is_nil(_objComponent))
     return false;
   else
     return true;
 }

void SalomeComponent::load ( Task * askingNode )

virtual

Load the component.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 88 of file SalomeComponent.cxx.

References YACS::ENGINE::ComponentInstance::_compoName, YACS::ENGINE::ComponentInstance::_container, _objComponent, YACS::ENGINE::getSALOMERuntime(), and YACS::ENGINE::SalomeContainer::loadComponent().

 {
   if(_container)
     {
       SalomeContainer *salomeContainer(dynamic_cast<SalomeContainer *>(_container));
       if(salomeContainer)
         {
           _objComponent=salomeContainer->loadComponent(askingNode);
           return ;
         }
       throw Exception("Unrecognized type of Container ! Only Salome are supported by the Salome components !");
     }
   //throw Exception("SalomeComponent::load : no container specified !!! To be implemented in executor to allocate default a Container in case of presenceOfDefaultContainer.");
   //This component has no specified container : use default container policy
   SALOME_NamingService ns(getSALOMERuntime()->getOrb());
   SALOME_LifeCycleCORBA LCC(&ns);
   Engines::ContainerParameters params;
   LCC.preSet(params);
   params.resource_params.name = "localhost";
   params.container_name ="FactoryServer";
   _objComponent=LCC.LoadComponent(params,_compoName.c_str());
 }

bool SalomeComponent::setContainer ( Container * cont )

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 153 of file SalomeComponent.cxx.

References YACS::ENGINE::ComponentInstance::_compoName, YACS::ENGINE::ComponentInstance::_container, YACS::ENGINE::Container::addComponentName(), and YACS::ENGINE::ComponentInstance::setContainer().

 {
   if(!dynamic_cast<SalomeContainer *>(cont))
     throw Exception("SalomeComponent::setContainer : a Salome component must be attached to a Salome container !");
   if(ComponentInstance::setContainer(cont))
     {
       if(_container)
         _container->addComponentName(_compoName);
       return true;
     }
   else
     return false;
 }

void SalomeComponent::shutdown ( int level )

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 167 of file SalomeComponent.cxx.

References YACS::ENGINE::ComponentInstance::_container, DEBTRACE, and YACS::ENGINE::Container::shutdown().

 {
   DEBTRACE("SalomeComponent::shutdown " << level);
   if(_container)
     _container->shutdown(level);
 }

void SalomeComponent::unload ( Task * askingNode )

virtual

Unload the component.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 71 of file SalomeComponent.cxx.

 {
   //Not implemented
   std::cerr << "SalomeComponent::unload : not implemented " << std::endl;
 }

Member Data Documentation

CORBA::Object_var YACS::ENGINE::SalomeComponent::_objComponent

protected

Definition at line 56 of file SalomeComponent.hxx.

Referenced by isLoaded(), load(), and SalomeComponent().

const char SalomeComponent::KIND ="Salome"

static

Definition at line 52 of file SalomeComponent.hxx.

Referenced by YACS::ENGINE::SalomeContainer::checkCapabilityToDealWith(), YACS::ENGINE::SalomePythonComponent::getKind(), getKind(), YACS::ENGINE::SalomeHPComponent::getKindForNode(), and getKindForNode().

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

src/runtime/SalomeComponent.hxx
src/runtime/SalomeComponent.cxx

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation