YACS::ENGINE::SalomeHPComponent Class Reference

#include <SalomeHPComponent.hxx>

Inheritance diagram for YACS::ENGINE::SalomeHPComponent:

Collaboration diagram for YACS::ENGINE::SalomeHPComponent:

Public Member Functions
	SalomeHPComponent (const std::string &name)
	SalomeHPComponent (const SalomeHPComponent &other)
virtual	~SalomeHPComponent ()
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 () const

Static Public Attributes
static const char	KIND [] ="HPSalome"
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 ()
Protected Member Functions inherited from YACS::ENGINE::RefCounter
	RefCounter ()
	RefCounter (const RefCounter &other)
virtual	~RefCounter ()
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

Definition at line 31 of file SalomeHPComponent.hxx.

Constructor & Destructor Documentation

SalomeHPComponent() [1/2]

SalomeHPComponent::SalomeHPComponent

(

const std::string &

name

)

Definition at line 44 of file SalomeHPComponent.cxx.

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

References _objComponent.

Referenced by clone(), and cloneAlways().

SalomeHPComponent() [2/2]

SalomeHPComponent::SalomeHPComponent

(

const SalomeHPComponent &

other

)

Definition at line 49 of file SalomeHPComponent.cxx.

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

References _objComponent.

~SalomeHPComponent()

SalomeHPComponent::~SalomeHPComponent ( )

virtual

Definition at line 54 of file SalomeHPComponent.cxx.

{
}

Member Function Documentation

clone()

ComponentInstance * SalomeHPComponent::clone ( ) const

virtual

Clone the component instance.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 119 of file SalomeHPComponent.cxx.

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

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

cloneAlways()

ComponentInstance * SalomeHPComponent::cloneAlways ( ) const

virtual

Implements YACS::ENGINE::ComponentInstance.

Definition at line 130 of file SalomeHPComponent.cxx.

{
  return new SalomeHPComponent(*this);
}

References SalomeHPComponent().

createNode()

ServiceNode * SalomeHPComponent::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 111 of file SalomeHPComponent.cxx.

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

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

getCompoPtr()

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

inlinevirtual

Definition at line 45 of file SalomeHPComponent.hxx.

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

getFileRepr()

std::string SalomeHPComponent::getFileRepr ( ) const

virtual

For dump in file.

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 135 of file SalomeHPComponent.cxx.

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

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

getKind()

std::string SalomeHPComponent::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 58 of file SalomeHPComponent.cxx.

{
  return KIND;
}

References KIND.

getKindForNode()

std::string SalomeHPComponent::getKindForNode ( ) const

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 63 of file SalomeHPComponent.cxx.

{
  return SalomeComponent::KIND;
}

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

isLoaded()

bool SalomeHPComponent::isLoaded ( Task *  askingNode ) const

virtual

Is the component instance already loaded ?

Implements YACS::ENGINE::ComponentInstance.

Definition at line 76 of file SalomeHPComponent.cxx.

{
  return false;
}

load()

void SalomeHPComponent::load ( Task *  askingNode )

virtual

Load the component.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 83 of file SalomeHPComponent.cxx.

{
  if(_container)
    {
      SalomeHPContainer *salomeContainer(dynamic_cast<SalomeHPContainer *>(_container));
      if(salomeContainer)
        {
          YACS::BASES::AutoCppPtr<SalomeContainerTmpForHP> tmpCont(SalomeContainerTmpForHP::BuildFrom(salomeContainer,askingNode));
          _objComponent=tmpCont->loadComponent(askingNode);
          return ;
        }
      throw Exception("Unrecognized type of Container ! Only Salome and HPSalome container are supported by the Salome components !");
    }
  else
    throw Exception("No container on HP component ! Impossible to load !");
}

References YACS::ENGINE::ComponentInstance::_container, _objComponent, and YACS::ENGINE::SalomeContainerTmpForHP::BuildFrom().

setContainer()

bool SalomeHPComponent::setContainer ( Container *  cont )

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 142 of file SalomeHPComponent.cxx.

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

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

shutdown()

void SalomeHPComponent::shutdown ( int  level )

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 156 of file SalomeHPComponent.cxx.

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

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

unload()

void SalomeHPComponent::unload ( Task *  askingNode )

virtual

Unload the component.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 69 of file SalomeHPComponent.cxx.

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

Member Data Documentation

_objComponent

CORBA::Object_var YACS::ENGINE::SalomeHPComponent::_objComponent

protected

Definition at line 52 of file SalomeHPComponent.hxx.

Referenced by load(), and SalomeHPComponent().

KIND

const char SalomeHPComponent::KIND ="HPSalome"

static

Definition at line 48 of file SalomeHPComponent.hxx.

Referenced by YACS::ENGINE::SalomeHPContainer::checkCapabilityToDealWith(), and getKind().

---

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

• src/runtime/SalomeHPComponent.hxx
• src/runtime/SalomeHPComponent.cxx