#include <CppComponent.hxx>

Inheritance diagram for YACS::ENGINE::CppComponent:

[legend]

Collaboration diagram for YACS::ENGINE::CppComponent:

[legend]

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

	CppComponent (void *obj, RunFunction r, TerminateFunction t, const std::string &name)

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

virtual	~CppComponent ()

void	run (const char service, int nbIn, int nbOut, Any argIn, Any *argOut)

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

virtual std::string	getKindForNode () const

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

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

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

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

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

virtual YACS::ENGINE::ComponentInstance *	cloneAlways () 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

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

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

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
void *	__obj

YACS::ENGINE::RunFunction	__run

YACS::ENGINE::TerminateFunction	__terminate

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 44 of file CppComponent.hxx.

Constructor & Destructor Documentation

◆ CppComponent() [1/3]

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

CppComponent constructor.

Definition at line 86 of file CppComponent.cxx.

                                                : ComponentInstance(name), __obj(0), __run(0),__terminate(0)
{
  _container = getRuntime()->createContainer(CppNode::KIND);
  /* This part of code has been commented because the load part is supposed to do that !
  if (!_container->isAlreadyStarted(0))
    _container->start(0);
  CppContainer * _containerC = dynamic_cast<CppContainer *> (_container);
  _containerC->createInternalInstance(name, __obj, __run, __terminate);*/
}

References YACS::ENGINE::ComponentInstance::_container, YACS::ENGINE::Runtime::createContainer(), YACS::ENGINE::getRuntime(), and YACS::ENGINE::CppNode::KIND.

Referenced by clone(), and cloneAlways().

◆ CppComponent() [2/3]

YACS::ENGINE::CppComponent::CppComponent	(	void *	obj,
		RunFunction	r,
		TerminateFunction	t,
		const std::string &	name
	)

inline

Definition at line 48 of file CppComponent.hxx.

50 : __obj(obj), __run(r), __terminate(t), ComponentInstance(name) {}

gui.Appli.t

t

Definition: Appli.py:472

testCppPluginInvokation.r

r

Definition: testCppPluginInvokation.py:28

◆ CppComponent() [3/3]

CppComponent::CppComponent ( const CppComponent & other )

CppComponent copy constructor.

Definition at line 97 of file CppComponent.cxx.

                                                    : ComponentInstance(other._compoName), __obj(0), __run(0),__terminate(0)
{
  _container = getRuntime()->createContainer(CppNode::KIND);
  /* This part of code has been commented because the load part is supposed to do that !
  if (!_container->isAlreadyStarted(0))
    _container->start(0);
  CppContainer * _containerC = dynamic_cast<CppContainer *> (_container);  
   _containerC->createInternalInstance(_compoName, __obj, __run, __terminate);*/
}

References YACS::ENGINE::ComponentInstance::_container, YACS::ENGINE::Runtime::createContainer(), YACS::ENGINE::getRuntime(), and YACS::ENGINE::CppNode::KIND.

◆ ~CppComponent()

CppComponent::~CppComponent ( )

virtual

Definition at line 107 of file CppComponent.cxx.

{
  DEBTRACE("CppComponent::~CppComponent()");
  if (__terminate) __terminate(&__obj);
  if (_container)
    ((CppContainer *) _container)->unregisterComponentInstance(this);
}

References __obj, __terminate, YACS::ENGINE::ComponentInstance::_container, and DEBTRACE.

Member Function Documentation

◆ clone()

ComponentInstance * CppComponent::clone ( ) const

virtual

Clone the component instance.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 215 of file CppComponent.cxx.

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

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

◆ cloneAlways()

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

virtual

Implements YACS::ENGINE::ComponentInstance.

Definition at line 226 of file CppComponent.cxx.

{
  return new CppComponent(*this);
}

References CppComponent().

◆ createNode()

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

virtual

Implements YACS::ENGINE::ComponentInstance.

Definition at line 207 of file CppComponent.cxx.

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

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

◆ getKind()

std::string CppComponent::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 75 of file CppComponent.cxx.

{
  return CppComponent::KIND;
}

References KIND.

◆ getKindForNode()

std::string CppComponent::getKindForNode ( ) const

virtual

Reimplemented from YACS::ENGINE::ComponentInstance.

Definition at line 80 of file CppComponent.cxx.

{
  return CppComponent::KIND;
}

References KIND.

◆ isLoaded()

bool CppComponent::isLoaded ( Task * askingNode ) const

virtual

Is the component instance already loaded ?

Implements YACS::ENGINE::ComponentInstance.

Definition at line 160 of file CppComponent.cxx.

{
  return NULL != __obj;
}

References __obj.

◆ load()

void CppComponent::load ( Task * askingNode )

virtual

Load the component instance.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 165 of file CppComponent.cxx.

{
  if (!_container)
    {
      _container = getRuntime()->createContainer(CppNode::KIND);
    }
 
  if(_container)
    {
      CppContainer *containerC(dynamic_cast< CppContainer *> (_container));
      if(!containerC)
        throw Exception("The type of container should be CPP for component CPP !");
      containerC->lock();//To be sure
      if(!_container->isAlreadyStarted(askingNode))
        {
          try
          {
              _container->start(askingNode);
          }
          catch(Exception& e)
          {
              containerC->unLock();
              throw e;
          }
        }
      containerC->unLock();
      containerC->lock();//To be sure
 
      bool isLoadable(containerC->loadComponentLibrary(_compoName));
      if (isLoadable) 
        containerC->createInternalInstance(_compoName, __obj, __run, __terminate);
 
      if(NULL == __obj)
        {
          containerC->unLock();
          throw Exception("CppComponent::load : Error while trying to create a new component.");
        }
      containerC->unLock();
      return;
    }
}

References __obj, __run, __terminate, YACS::ENGINE::ComponentInstance::_compoName, YACS::ENGINE::ComponentInstance::_container, YACS::ENGINE::Runtime::createContainer(), YACS::ENGINE::CppContainer::createInternalInstance(), YACS::ENGINE::getRuntime(), YACS::ENGINE::Container::isAlreadyStarted(), YACS::ENGINE::CppNode::KIND, YACS::ENGINE::CppContainer::loadComponentLibrary(), YACS::ENGINE::CppContainer::lock(), YACS::ENGINE::Container::start(), and YACS::ENGINE::CppContainer::unLock().

◆ run()

void CppComponent::run	(	const char *	service,
		int	nbIn,
		int	nbOut,
		Any **	argIn,
		Any **	argOut
	)

Definition at line 115 of file CppComponent.cxx.

{
  int i;
  returnInfo return_code;
    
#ifdef _DEVDEBUG_
  std::ostringstream sDebug;
  sDebug << getInstanceName() << "::" << service << "(";
  for (i=0; i<nbIn; i++) {
     sDebug << *(argIn[i]);
     if (i<nbIn-1)
        sDebug << ", ";
  }
  sDebug << ")";
#endif
 
  __run(__obj, service, nbIn, nbOut, argIn, argOut, &return_code);
    
  if (return_code.code != 0) {
#ifdef _DEVDEBUG_
    std::cerr << sDebug << " ???" << std::endl;
#endif
    throw YACS::Exception(return_code.message);
  }
 
#ifdef _DEVDEBUG_
  if (nbOut > 0) {
    sDebug << "->";
    for (i=0; i<nbOut; i++) {
       sDebug << " " << *(argOut[i]);
    }
  }
  DEBTRACE(sDebug.str());
#endif
}

References __obj, __run, YACS::ENGINE::returnInfo::code, DEBTRACE, YACS::ENGINE::ComponentInstance::getInstanceName(), yacsorb.CORBAEngineTest::i, and YACS::ENGINE::returnInfo::message.

Referenced by YACS::ENGINE::CppNode::execute().

◆ unload()

void CppComponent::unload ( Task * askingNode )

virtual

Unload the component.

Implements YACS::ENGINE::ComponentInstance.

Definition at line 153 of file CppComponent.cxx.

{
  //Not implemented
  DEBTRACE("CppComponent::unload : not implemented ");
}

References DEBTRACE.

Member Data Documentation

◆ __obj

void* YACS::ENGINE::CppComponent::__obj

protected

Definition at line 69 of file CppComponent.hxx.

Referenced by isLoaded(), load(), run(), and ~CppComponent().

◆ __run

YACS::ENGINE::RunFunction YACS::ENGINE::CppComponent::__run

protected

Definition at line 70 of file CppComponent.hxx.

Referenced by load(), and run().

◆ __terminate

YACS::ENGINE::TerminateFunction YACS::ENGINE::CppComponent::__terminate

protected

Definition at line 71 of file CppComponent.hxx.

Referenced by load(), and ~CppComponent().

◆ KIND

const char CppComponent::KIND = "Cpp"

static

Definition at line 57 of file CppComponent.hxx.

Referenced by YACS::ENGINE::CppContainer::checkCapabilityToDealWith(), YACS::ENGINE::RuntimeSALOME::createComponentInstance(), getKind(), and getKindForNode().

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

src/runtime/CppComponent.hxx
src/runtime/CppComponent.cxx

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CppComponent() [1/3]

◆ CppComponent() [2/3]

◆ CppComponent() [3/3]

◆ ~CppComponent()

Member Function Documentation

◆ clone()

◆ cloneAlways()

◆ createNode()

◆ getKind()

◆ getKindForNode()

◆ isLoaded()

◆ load()

◆ run()

◆ unload()

Member Data Documentation

◆ __obj

◆ __run

◆ __terminate

◆ KIND