OpenRTM-aist 2.0.2
Loading...
Searching...
No Matches
SDOPackage::PeriodicECOrganization Class Reference

PeriodicECOrganization class. More...

#include <PeriodicECSharedComposite.h>

Inheritance diagram for SDOPackage::PeriodicECOrganization:
Collaboration diagram for SDOPackage::PeriodicECOrganization:

Classes

class  Member
 

Public Member Functions

 PeriodicECOrganization (::RTC::RTObject_impl *rtobj, SDOSystemElement_ptr sdo)
 Constructor.
 
 ~PeriodicECOrganization () override
 Destructor.
 
::CORBA::Boolean add_members (const SDOList &sdo_list) override
 [CORBA interface] Add Organization member
 
::CORBA::Boolean set_members (const SDOList &sdo_list) override
 [CORBA interface] Set Organization member
 
::CORBA::Boolean remove_member (const char *id) override
 [CORBA interface] Remove a member of Organization
 
void removeAllMembers ()
 Remove a member of Organization .
 
void updateDelegatedPorts ()
 Update/Remove a member of Organization .
 
- Public Member Functions inherited from SDOPackage::Organization_impl
 Organization_impl (SDOSystemElement_ptr sdo)
 Constructor.
 
 ~Organization_impl () override
 Virtual destructor.
 
char * get_organization_id () override
 [CORBA interface] Get Organization ID
 
CORBA::Boolean add_organization_property (const OrganizationProperty &organization_property) override
 [CORBA interface] Set OrganizationProperty
 
OrganizationProperty * get_organization_property () override
 [CORBA interface] Get OrganizationProperty
 
CORBA::Any * get_organization_property_value (const char *name) override
 [CORBA interface] Get specified value of OrganizationProperty
 
CORBA::Boolean set_organization_property_value (const char *name, const CORBA::Any &value) override
 [CORBA interface] Set specified value of OrganizationProperty
 
CORBA::Boolean remove_organization_property (const char *name) override
 [CORBA interface] Remove specified OrganizationProperty
 
CORBA::Boolean add_members (const SDOList &sdo_list) override
 [CORBA interface] Add the member SDOs
 
SDOList * get_members () override
 [CORBA interface] Get the member list of the Organization
 
CORBA::Boolean set_members (const SDOList &sdos) override
 [CORBA interface] Set SDO
 
CORBA::Boolean remove_member (const char *id) override
 [CORBA interface] Remove member SDO from Organization
 
SDOSystemElement_ptr get_owner () override
 [CORBA interface] Get the owner of Organization
 
CORBA::Boolean set_owner (SDOSystemElement_ptr sdo) override
 [CORBA interface] Set the owner to the Organization
 
DependencyType get_dependency () override
 [CORBA interface] Get the DependencyType of the Organization
 
CORBA::Boolean set_dependency (DependencyType dependency) override
 [CORBA interface] Set the DependencyType of the Organization
 
Organization_ptr getObjRef ()
 

Protected Types

using MemIt = std::vector<Member>::iterator
 

Protected Member Functions

void addOrganizationToTarget (Member &member)
 Set Organization object to target DFC .
 
void removeOrganizationFromTarget (Member &member)
 Remove Organization object from a target DFC .
 
void addRTCToEC (RTC::RTObject_ptr rtobj)
 
void addParticipantToEC (Member &member)
 Set CompositeRTC's ExecutionContext to the given DFC .
 
void removeParticipantFromEC (Member &member)
 Remove participant DFC from CompositeRTC's ExecutionContext .
 
void addPort (Member &member, PortList &portlist)
 Delegate given RTC's ports to the Composite .
 
void removePort (Member &member, PortList &portlist)
 Remove delegated participatns's ports from the composite .
 
void updateExportedPortsList ()
 PortsList is updated. .
 

Static Protected Member Functions

static bool sdoToDFC (SDO_ptr sdo, ::OpenRTM::DataFlowComponent_ptr &dfc)
 Conversion from SDO to DFC .
 
static void stopOwnedEC (Member &member)
 Stop Owned ExecutionContexts .
 
static void startOwnedEC (Member &member)
 Start Owned ExecutionContexts .
 
static void print (const PortList &p)
 Output PortList to StandardOutput. .
 

Protected Attributes

RTC::Logger rtclog
 Logger stream .
 
::RTC::RTObject_implm_rtobj
 RT Object .
 
::RTC::ExecutionContext_var m_ec
 ExecutionContext Object reference .
 
std::vector< Memberm_rtcMembers
 Member list .
 
PortList m_expPorts
 Port List .
 
- Protected Attributes inherited from SDOPackage::Organization_impl
::RTC::Logger rtclog
 
Organization_var m_objref
 
std::string m_pId
 The identifier of the Organization. .
 
SDOPackage::SDOList m_memberList
 A list of SDO members associated with the Organization .
 
SDOPackage::SDOSystemElement_var m_varOwner
 The owner of the Organization .
 
SDOPackage::DependencyType m_dependency
 Dependency type.
 
SDOPackage::OrganizationProperty m_orgProperty
 Organization property.
 
std::mutex m_org_mutex
 

Detailed Description

PeriodicECOrganization class.

Implement of Organization_imp

Member Typedef Documentation

◆ MemIt

using SDOPackage::PeriodicECOrganization::MemIt = std::vector<Member>::iterator
protected

Constructor & Destructor Documentation

◆ PeriodicECOrganization()

SDOPackage::PeriodicECOrganization::PeriodicECOrganization ( ::RTC::RTObject_impl * rtobj,
SDOSystemElement_ptr sdo )
explicit

Constructor.

Constructor

Parameters
rtobjObject

◆ ~PeriodicECOrganization()

SDOPackage::PeriodicECOrganization::~PeriodicECOrganization ( )
override

Destructor.

Destructor

Member Function Documentation

◆ add_members()

::CORBA::Boolean SDOPackage::PeriodicECOrganization::add_members ( const SDOList & sdo_list)
override

[CORBA interface] Add Organization member

This operation adds the given SDOList to the existing organization's member list

Parameters
sdo_listSDO member list to be added
Returns
boolean will returned if the operation succeed

◆ addOrganizationToTarget()

void SDOPackage::PeriodicECOrganization::addOrganizationToTarget ( Member & member)
protected

Set Organization object to target DFC .

◆ addParticipantToEC()

void SDOPackage::PeriodicECOrganization::addParticipantToEC ( Member & member)
protected

Set CompositeRTC's ExecutionContext to the given DFC .

◆ addPort()

void SDOPackage::PeriodicECOrganization::addPort ( Member & member,
PortList & portlist )
protected

Delegate given RTC's ports to the Composite .

◆ addRTCToEC()

void SDOPackage::PeriodicECOrganization::addRTCToEC ( RTC::RTObject_ptr rtobj)
protected

◆ print()

static void SDOPackage::PeriodicECOrganization::print ( const PortList & p)
inlinestaticprotected

Output PortList to StandardOutput. .

◆ remove_member()

::CORBA::Boolean SDOPackage::PeriodicECOrganization::remove_member ( const char * id)
override

[CORBA interface] Remove a member of Organization

This operation removes a SDO from existing member list by specified ID.

Parameters
idThe ID of the SDO to be removed
Returns
boolean will returned if the operation succeed

◆ removeAllMembers()

void SDOPackage::PeriodicECOrganization::removeAllMembers ( )

Remove a member of Organization .

◆ removeOrganizationFromTarget()

void SDOPackage::PeriodicECOrganization::removeOrganizationFromTarget ( Member & member)
protected

Remove Organization object from a target DFC .

◆ removeParticipantFromEC()

void SDOPackage::PeriodicECOrganization::removeParticipantFromEC ( Member & member)
protected

Remove participant DFC from CompositeRTC's ExecutionContext .

◆ removePort()

void SDOPackage::PeriodicECOrganization::removePort ( Member & member,
PortList & portlist )
protected

Remove delegated participatns's ports from the composite .

◆ sdoToDFC()

static bool SDOPackage::PeriodicECOrganization::sdoToDFC ( SDO_ptr sdo,
::OpenRTM::DataFlowComponent_ptr & dfc )
staticprotected

Conversion from SDO to DFC .

◆ set_members()

::CORBA::Boolean SDOPackage::PeriodicECOrganization::set_members ( const SDOList & sdo_list)
override

[CORBA interface] Set Organization member

This operation removes existing member list and sets the given SDOList to the existing organization's member list

Parameters
sdo_listSDO member list to be set
Returns
boolean will returned if the operation succeed

◆ startOwnedEC()

static void SDOPackage::PeriodicECOrganization::startOwnedEC ( Member & member)
staticprotected

Start Owned ExecutionContexts .

◆ stopOwnedEC()

static void SDOPackage::PeriodicECOrganization::stopOwnedEC ( Member & member)
staticprotected

Stop Owned ExecutionContexts .

◆ updateDelegatedPorts()

void SDOPackage::PeriodicECOrganization::updateDelegatedPorts ( )

Update/Remove a member of Organization .

◆ updateExportedPortsList()

void SDOPackage::PeriodicECOrganization::updateExportedPortsList ( )
protected

PortsList is updated. .

Member Data Documentation

◆ m_ec

::RTC::ExecutionContext_var SDOPackage::PeriodicECOrganization::m_ec
protected

ExecutionContext Object reference .

◆ m_expPorts

PortList SDOPackage::PeriodicECOrganization::m_expPorts
protected

Port List .

◆ m_rtcMembers

std::vector<Member> SDOPackage::PeriodicECOrganization::m_rtcMembers
protected

Member list .

◆ m_rtobj

::RTC::RTObject_impl* SDOPackage::PeriodicECOrganization::m_rtobj
protected

RT Object .

◆ rtclog

RTC::Logger SDOPackage::PeriodicECOrganization::rtclog
protected

Logger stream .


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