Version: 9.15.0
uses_port Class Referenceabstract

This class implements a DSC_User uses C++ port. More...

#include <uses_port.hxx>

Inheritance diagram for uses_port:

Public Member Functions

 uses_port ()
 
virtual ~uses_port ()
 
virtual const char * get_repository_id ()=0
 This is used by the component to get the CORBA repository id of the uses port. More...
 
virtual void uses_port_changed (Engines::DSC::uses_port *new_uses_port, const Engines::DSC::Message message)=0
 This method is the uses port's callback to be aware of connections states. More...
 
virtual Ports::PortProperties_ptr get_port_properties ()
 This is used to get the property object of the port. More...
 

Protected Attributes

PortProperties_idefault_properties
 

Detailed Description

This class implements a DSC_User uses C++ port.

This class is base class for all DSC_User uses port. It's an abstract class.

Contrary to DSC_Basic layer, a uses port as an implementation provided by this class which permits to manipulate the uses port.

Constructor & Destructor Documentation

◆ uses_port()

uses_port::uses_port ( )

◆ ~uses_port()

uses_port::~uses_port ( )
virtual

Member Function Documentation

◆ get_port_properties()

Ports::PortProperties_ptr base_port::get_port_properties ( )
virtualinherited

This is used to get the property object of the port.

Returns
property's CORBA reference.

References base_port::default_properties.

◆ get_repository_id()

virtual const char* uses_port::get_repository_id ( )
pure virtual

This is used by the component to get the CORBA repository id of the uses port.

It's an abstract method.

Returns
port's CORBA repository id.

Implemented in GenericUsesPort< DataManipulator, CorbaPortType, repositoryName, UsesPort >, GenericUsesPort< DataManipulator, CorbaPortType, repositoryName, calcium_uses_port >, and data_short_port_uses.

◆ uses_port_changed()

virtual void uses_port::uses_port_changed ( Engines::DSC::uses_port new_uses_port,
const Engines::DSC::Message  message 
)
pure virtual

This method is the uses port's callback to be aware of connections states.

It's an abstract method. The uses port uses this method to manage the sequence of the DSC_Basic uses port.

Parameters
new_uses_portnew uses port sequence.
messagemessage associated with this modification.

Implemented in data_short_port_uses, GenericUsesPort< DataManipulator, CorbaPortType, repositoryName, UsesPort >, and GenericUsesPort< DataManipulator, CorbaPortType, repositoryName, calcium_uses_port >.

Field Documentation

◆ default_properties

PortProperties_i* base_port::default_properties
protectedinherited