Engines_DSC_i Class Reference

This class implements the interface Engines::DSC. More...

#include <DSC_i.hxx>

Inheritance diagram for Engines_DSC_i:

Collaboration diagram for Engines_DSC_i:

Public Member Functions
	Engines_DSC_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa, PortableServer::ObjectId *contId, const char *instanceName, const char *interfaceName, bool notif=false)
	Engines_DSC_i (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa, Engines::Container_ptr container, const char *instanceName, const char *interfaceName, bool notif=false, bool regist=true)
virtual	~Engines_DSC_i ()
virtual void	add_provides_port (Ports::Port_ptr ref, const char *provides_port_name, Ports::PortProperties_ptr port_prop) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::NilPort, Engines::DSC::BadProperty)
virtual void	add_uses_port (const char *repository_id, const char *uses_port_name, Ports::PortProperties_ptr port_prop) throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::BadProperty)
virtual Ports::Port_ptr	get_provides_port (const char *provides_port_name, const CORBA::Boolean connection_error) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtual Engines::DSC::uses_port *	get_uses_port (const char *uses_port_name) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtual void	connect_provides_port (const char *provides_port_name) throw (Engines::DSC::PortNotDefined)
virtual void	connect_uses_port (const char *uses_port_name, Ports::Port_ptr provides_port_ref) throw (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort)
virtual CORBA::Boolean	is_connected (const char *port_name) throw (Engines::DSC::PortNotDefined)
virtual void	disconnect_provides_port (const char *provides_port_name, const Engines::DSC::Message message) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected)
virtual void	disconnect_uses_port (const char *uses_port_name, Ports::Port_ptr provides_port_ref, const Engines::DSC::Message message) throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected, Engines::DSC::BadPortReference)
virtual Ports::PortProperties_ptr	get_port_properties (const char *port_name) throw (Engines::DSC::PortNotDefined)
virtual void	provides_port_changed (const char *provides_port_name, int connection_nbr, const Engines::DSC::Message message)=0
	This method is used by the component when the number of connection on a provides port changes.
virtual void	uses_port_changed (const char *uses_port_name, Engines::DSC::uses_port *new_uses_port, const Engines::DSC::Message message)=0
	This method is used by the component when the number of connection on a uses port changes.
Static Public Member Functions
static void	writeEvent (const char *request, const std::string &containerName, const char *instance_name, const char *port_name, const char *error, const char *message)
	Write a record in the trace file.
Protected Types
enum	port_type { uses, provides, none }
typedef std::map< std::string, port_t * >	ports
Protected Attributes
ports	my_ports
ports::iterator	my_ports_it

---

Detailed Description

The implementation of methods are performed by the class Engines_DSC_interface.

---

Member Typedef Documentation

typedef std::map<std::string, port_t *> Engines_DSC_interface::ports [protected, inherited]

---

Member Enumeration Documentation

enum Engines_DSC_interface::port_type [protected, inherited]

Enumerator:

uses
provides
none

---

Constructor & Destructor Documentation

Engines_DSC_i::Engines_DSC_i	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_ptr	poa,
		PortableServer::ObjectId *	contId,
		const char *	instanceName,
		const char *	interfaceName,
		bool	notif = false
	)

Engines_DSC_i::Engines_DSC_i	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_ptr	poa,
		Engines::Container_ptr	container,
		const char *	instanceName,
		const char *	interfaceName,
		bool	notif = false,
		bool	regist = true
	)

Engines_DSC_i::~Engines_DSC_i

(

)

[virtual]

---

Member Function Documentation

virtual void Engines_DSC_i::add_provides_port	(	Ports::Port_ptr	ref,
		const char *	provides_port_name,
		Ports::PortProperties_ptr	port_prop
	)		throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::NilPort, Engines::DSC::BadProperty) [inline, virtual]

See also:

Engines::DSC::add_provides_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::add_provides_port().

virtual void Engines_DSC_i::add_uses_port	(	const char *	repository_id,
		const char *	uses_port_name,
		Ports::PortProperties_ptr	port_prop
	)		throw (Engines::DSC::PortAlreadyDefined, Engines::DSC::BadProperty) [inline, virtual]

See also:

Engines::DSC::add_uses_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::add_uses_port().

virtual Ports::Port_ptr Engines_DSC_i::get_provides_port	(	const char *	provides_port_name,
		const CORBA::Boolean	connection_error
	)		throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected) [inline, virtual]

See also:

Engines::DSC::get_provides_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::get_provides_port().

virtual Engines::DSC::uses_port* Engines_DSC_i::get_uses_port

(

const char *

uses_port_name

)

throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected) [inline, virtual]

See also:

Engines::DSC::get_uses_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::get_uses_port().

virtual void Engines_DSC_i::connect_provides_port

(

const char *

provides_port_name

)

throw (Engines::DSC::PortNotDefined) [inline, virtual]

See also:

Engines::DSC::connect_provides_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::connect_provides_port().

virtual void Engines_DSC_i::connect_uses_port	(	const char *	uses_port_name,
		Ports::Port_ptr	provides_port_ref
	)		throw (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort) [inline, virtual]

See also:

Engines::DSC::connect_uses_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::connect_uses_port().

virtual CORBA::Boolean Engines_DSC_i::is_connected

(

const char *

port_name

)

throw (Engines::DSC::PortNotDefined) [inline, virtual]

See also:

Engines::DSC::is_connected

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::is_connected().

virtual void Engines_DSC_i::disconnect_provides_port	(	const char *	provides_port_name,
		const Engines::DSC::Message	message
	)		throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected) [inline, virtual]

See also:

Engines::DSC::disconnect_provides_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::disconnect_provides_port().

virtual void Engines_DSC_i::disconnect_uses_port	(	const char *	uses_port_name,
		Ports::Port_ptr	provides_port_ref,
		const Engines::DSC::Message	message
	)		throw (Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected, Engines::DSC::BadPortReference) [inline, virtual]

See also:

Engines::DSC::disconnect_uses_port

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::disconnect_uses_port().

virtual Ports::PortProperties_ptr Engines_DSC_i::get_port_properties

(

const char *

port_name

)

throw (Engines::DSC::PortNotDefined) [inline, virtual]

See also:

Engines::DSC::get_port_properties

Reimplemented from Engines_DSC_interface.

References Engines_DSC_interface::get_port_properties().

void Engines_DSC_interface::writeEvent	(	const char *	request,
		const std::string &	containerName,
		const char *	instance_name,
		const char *	port_name,
		const char *	error,
		const char *	message
	)		[static, inherited]

Parameters:

request	the name of the request executed
containerName	the name of the container where the request is executed
instance_name	the name of the component where the request is executed
port_name	the name of the port that is concerned
error	if an error has occured, a string that identifies the error
message	informations about error or about the request

References initTrace().

virtual void DSC_Callbacks::provides_port_changed	(	const char *	provides_port_name,
		int	connection_nbr,
		const Engines::DSC::Message	message
	)		[pure virtual, inherited]

This information helps the user code to detect operation on its ports.

Parameters:

provides_port_name	the name of the provides name that has changed.
connection_nbr	the new number of connection on the provides port.
message	contains informations about the modification of the port.

Implemented in Superv_Component_i.

virtual void DSC_Callbacks::uses_port_changed	(	const char *	uses_port_name,
		Engines::DSC::uses_port *	new_uses_port,
		const Engines::DSC::Message	message
	)		[pure virtual, inherited]

This information helps the user code to detect operation on its ports.

Parameters:

uses_port_name	the name of the uses name that has changed.
new_uses_port	the new sequence representing the uses port.
message	contains informations about the modification of the port.

Implemented in Superv_Component_i.

---

Field Documentation

ports Engines_DSC_interface::my_ports [protected, inherited]

ports::iterator Engines_DSC_interface::my_ports_it [protected, inherited]