Core Class Reference

Manages core functionality for a robotic component, including lifecycle transitions and connections to afferent and efferent processing components. More...

#include <Core.hpp>

Inheritance diagram for Core:

Collaboration diagram for Core:

Public Member Functions
virtual bool	activate ()=0
	Activates the Core component.
virtual bool	configure ()=0
	Configures the Core component.
	Core (rclcpp_lifecycle::LifecycleNode::SharedPtr parent)
	Constructs a Core object associated with a parent lifecycle node.
virtual bool	deactivate ()=0
	Deactivates the Core component.
void	set_afferent (cs4home_core::Afferent::SharedPtr afferent)
	Sets the Afferent component associated with this Core.
void	set_efferent (cs4home_core::Efferent::SharedPtr efferent)
	Sets the Efferent component associated with this Core.

Protected Attributes
cs4home_core::Afferent::SharedPtr	afferent_
	Shared pointer to the Afferent component.
cs4home_core::Efferent::SharedPtr	efferent_
	Shared pointer to the Efferent component.
rclcpp_lifecycle::LifecycleNode::SharedPtr	parent_
	Shared pointer to the parent lifecycle node.

Detailed Description

Manages core functionality for a robotic component, including lifecycle transitions and connections to afferent and efferent processing components.

Constructor & Destructor Documentation

Core()

Core ( rclcpp_lifecycle::LifecycleNode::SharedPtr parent )

explicit

Constructs a Core object associated with a parent lifecycle node.

Constructs a Core object associated with a given lifecycle node.

Parameters

parent

Shared pointer to the lifecycle node managing this Core instance.

Member Function Documentation

activate()

virtual bool activate ( )

pure virtual

Activates the Core component.

Returns

True if activation is successful.

Implemented in ImageFilter, and ImageFilterCB.

configure()

bool configure ( )

pure virtual

Configures the Core component.

Returns

True if configuration is successful.

Implemented in ImageFilter, and ImageFilterCB.

deactivate()

virtual bool deactivate ( )

pure virtual

Deactivates the Core component.

Returns

True if deactivation is successful.

Implemented in ImageFilter, and ImageFilterCB.

set_afferent()

void set_afferent

(

cs4home_core::Afferent::SharedPtr

afferent

)

Sets the Afferent component associated with this Core.

Parameters

afferent

Shared pointer to an Afferent component.

set_efferent()

void set_efferent

(

cs4home_core::Efferent::SharedPtr

efferent

)

Sets the Efferent component associated with this Core.

Parameters

efferent

Shared pointer to an Efferent component.

Member Data Documentation

afferent_

cs4home_core::Afferent::SharedPtr afferent_

protected

Shared pointer to the Afferent component.

efferent_

cs4home_core::Efferent::SharedPtr efferent_

protected

Shared pointer to the Efferent component.

parent_

rclcpp_lifecycle::LifecycleNode::SharedPtr parent_

protected

Shared pointer to the parent lifecycle node.

---

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

• cs4home_core/include/cs4home_core/Core.hpp
• cs4home_core/src/cs4home_core/Core.cpp