smacc::ISmaccComponent Class Reference

#include <component.h>

Inheritance diagram for smacc::ISmaccComponent:

Collaboration diagram for smacc::ISmaccComponent:

Public Member Functions
	ISmaccComponent ()
virtual	~ISmaccComponent ()
virtual std::string	getName () const

Protected Member Functions
virtual void	initialize (ISmaccClient *owner)
void	setStateMachine (ISmaccStateMachine *stateMachine)
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
template<typename TOrthogonal , typename TSourceObject >
void	onOrthogonalAllocation ()
template<typename TComponent >
void	requiresComponent (TComponent *&requiredComponentStorage)
template<typename TClient >
void	requiresClient (TClient *&requiredClientStorage)
virtual void	onInitialize ()
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingComponent (TArgs... targs)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingNamedComponent (std::string name, TArgs... targs)

Protected Attributes
ISmaccStateMachine *	stateMachine_
ISmaccClient *	owner_

Friends
class	ISmaccOrthogonal
class	ISmaccClient

Detailed Description

Definition at line 14 of file component.h.

Constructor & Destructor Documentation

ISmaccComponent()

smacc::ISmaccComponent::ISmaccComponent

(

)

Definition at line 15 of file smacc_component.cpp.

    : owner_(nullptr)
{
}

~ISmaccComponent()

smacc::ISmaccComponent::~ISmaccComponent ( )

virtual

Definition at line 11 of file smacc_component.cpp.

{
}

Member Function Documentation

createSiblingComponent()

template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>

SmaccComponentType * smacc::ISmaccComponent::createSiblingComponent ( TArgs...  targs )

protected

Definition at line 33 of file smacc_component_impl.h.

    {
        return this->owner_->createComponent<SmaccComponentType, TOrthogonal, TClient>(targs...);
    }

References smacc::ISmaccClient::createComponent(), and owner_.

Here is the call graph for this function:

createSiblingNamedComponent()

template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>

SmaccComponentType * smacc::ISmaccComponent::createSiblingNamedComponent ( std::string  name, TArgs...  targs  )

protected

Definition at line 39 of file smacc_component_impl.h.

    {
        return this->owner_->createNamedComponent<SmaccComponentType, TOrthogonal, TClient>(name, targs...);
    }

References smacc::ISmaccClient::createNamedComponent(), and owner_.

Here is the call graph for this function:

getName()

std::string smacc::ISmaccComponent::getName ( ) const

virtual

Definition at line 36 of file smacc_component.cpp.

{
    std::string keyname = demangleSymbol(typeid(*this).name());
    return keyname;
}

References smacc::introspection::demangleSymbol().

Referenced by smacc::components::CpTopicSubscriber< MessageType >::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

initialize()

void smacc::ISmaccComponent::initialize ( ISmaccClient *  owner )

protectedvirtual

Definition at line 20 of file smacc_component.cpp.

{
    owner_ = owner;
    this->onInitialize();
}

References onInitialize(), and owner_.

Here is the call graph for this function:

onInitialize()

void smacc::ISmaccComponent::onInitialize ( )

protectedvirtual

Reimplemented in smacc::components::CpRosControlInterface, cl_move_base_z::CostmapSwitch, cl_move_base_z::PlannerSwitcher, and cl_move_base_z::WaypointNavigator.

Definition at line 26 of file smacc_component.cpp.

{
 
}

Referenced by initialize().

Here is the caller graph for this function:

onOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void smacc::ISmaccComponent::onOrthogonalAllocation ( )

inlineprotected

Definition at line 38 of file component.h.

{}

postEvent() [1/2]

template<typename EventType >

void smacc::ISmaccComponent::postEvent ( )

protected

Referenced by smacc::components::CpTopicSubscriber< MessageType >::onOrthogonalAllocation().

Here is the caller graph for this function:

postEvent() [2/2]

template<typename EventType >

void smacc::ISmaccComponent::postEvent ( const EventType &  ev )

protected

Definition at line 15 of file smacc_component_impl.h.

    {
        stateMachine_->postEvent(ev);
    }

References smacc::ISmaccStateMachine::postEvent(), and stateMachine_.

Here is the call graph for this function:

requiresClient()

template<typename TClient >

void smacc::ISmaccComponent::requiresClient ( TClient *&  requiredClientStorage )

protected

Definition at line 27 of file smacc_component_impl.h.

    {
        this->owner_->requiresClient(requiredClientStorage);
    }

References owner_, and smacc::ISmaccClient::requiresClient().

Here is the call graph for this function:

requiresComponent()

template<typename TComponent >

void smacc::ISmaccComponent::requiresComponent ( TComponent *&  requiredComponentStorage )

protected

Definition at line 21 of file smacc_component_impl.h.

    {
        requiredComponentStorage = this->owner_->getComponent<TComponent>();
    }

References smacc::ISmaccClient::getComponent(), and owner_.

Here is the call graph for this function:

setStateMachine()

void smacc::ISmaccComponent::setStateMachine ( ISmaccStateMachine *  stateMachine )

protected

Definition at line 31 of file smacc_component.cpp.

{
    stateMachine_ = stateMachine;
}

References stateMachine_.

Friends And Related Function Documentation

ISmaccClient

friend class ISmaccClient

friend

Definition at line 60 of file component.h.

ISmaccOrthogonal

friend class ISmaccOrthogonal

friend

Definition at line 59 of file component.h.

Member Data Documentation

owner_

ISmaccClient* smacc::ISmaccComponent::owner_

protected

Definition at line 57 of file component.h.

Referenced by createSiblingComponent(), createSiblingNamedComponent(), initialize(), cl_move_base_z::CostmapSwitch::onInitialize(), cl_move_base_z::PlannerSwitcher::onInitialize(), cl_move_base_z::WaypointNavigator::onInitialize(), requiresClient(), and requiresComponent().

stateMachine_

ISmaccStateMachine* smacc::ISmaccComponent::stateMachine_

protected

Definition at line 55 of file component.h.

Referenced by postEvent(), and setStateMachine().

---

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

• smacc/include/smacc/component.h
• smacc/include/smacc/impl/smacc_component_impl.h
• smacc/src/smacc/smacc_component.cpp