Fabric 0.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
fabric::CompatibilityValidation Class Reference

Syntax validation plugin for XML plans. More...

#include <compatibility_plugin.hpp>

Inheritance diagram for fabric::CompatibilityValidation:
Inheritance graph
[legend]
Collaboration diagram for fabric::CompatibilityValidation:
Collaboration graph
[legend]

Public Member Functions

 CompatibilityValidation ()=default
 
virtual ~CompatibilityValidation ()=default
 
void initialize (const rclcpp::Node::SharedPtr &node) override
 Initialize the syntax validation plugin.
 
void validate (fabric::Plan &plan, std::vector< CapabilityInfo > &capabilities) override
 Validate the given XML plan for compatibility.
 
- Public Member Functions inherited from fabric::ValidationBase
virtual ~ValidationBase ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from fabric::ValidationBase
void initialize_base (const rclcpp::Node::SharedPtr &node, const std::string &plugin_name)
 Base initialization method for derived classes.
 
- Protected Attributes inherited from fabric::ValidationBase
rclcpp::Node::SharedPtr node_
 Shared pointer to the ROS2 node.
 
std::string plugin_name_
 Name of the validation plugin.
 

Detailed Description

Syntax validation plugin for XML plans.

This plugin checks the XML plan for basic syntax errors (well-formedness, root tag, etc).

Constructor & Destructor Documentation

◆ CompatibilityValidation()

fabric::CompatibilityValidation::CompatibilityValidation ( )
default

◆ ~CompatibilityValidation()

virtual fabric::CompatibilityValidation::~CompatibilityValidation ( )
virtualdefault

Member Function Documentation

◆ initialize()

void fabric::CompatibilityValidation::initialize ( const rclcpp::Node::SharedPtr &  node)
inlineoverridevirtual

Initialize the syntax validation plugin.

Reimplemented from fabric::ValidationBase.

◆ validate()

void fabric::CompatibilityValidation::validate ( fabric::Plan plan,
std::vector< CapabilityInfo > &  capabilities 
)
inlineoverridevirtual

Validate the given XML plan for compatibility.

Parameters
planThe fabric::Plan to validate.
capabilitiesSupport data for evaluation as a vector of fabric::CapabilityInfo.

Implements fabric::ValidationBase.


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