AutoAPMS
Streamlining behaviors in ROS 2
Loading...
Searching...
No Matches
NodeManifestResource Class Reference

Class containing behavior tree node manifest resource data. More...

#include <auto_apms_behavior_tree_core/node/node_manifest.hpp>

Public Member Functions

 NodeManifestResource (const Identity &search_identity)
 Constructor of a node manifest resource object.
 
 NodeManifestResource (const std::string &search_identity)
 Constructor of a node manifest resource object.
 
 NodeManifestResource (const char *search_identity)
 Constructor of a node manifest resource object.
 
const Identity & getIdentity () const
 Get the unique identity for this resource.
 
const NodeManifest & getNodeManifest () const
 Get the node manifest object associated with this resource.
 
const NodeModelMap & getNodeModel () const
 Get the node model object associated with this resource.
 

Detailed Description

Class containing behavior tree node manifest resource data.

Definition at line 296 of file node_manifest.hpp.

Constructor & Destructor Documentation

◆ NodeManifestResource() [1/3]

NodeManifestResource ( const Identity & search_identity)

Constructor of a node manifest resource object.

Parameters
search_identityNode manifest resource identity used for searching the corresponding resource.
Exceptions
auto_apms_util::exceptions::ResourceIdentityFormatErrorif search_identity has wrong format.
auto_apms_util::exceptions::ResourceErrorif resource cannot be determined using search_identity.
auto_apms_behavior_tree::exceptions::NodeManifestErrorif the resource is not a valid node manifest.

Definition at line 257 of file node_manifest.cpp.

◆ NodeManifestResource() [2/3]

NodeManifestResource ( const std::string & search_identity)

Constructor of a node manifest resource object.

Parameters
search_identityNode manifest resource identity string used for searching the corresponding resource.
Exceptions
auto_apms_util::exceptions::ResourceIdentityFormatErrorif search_identity has wrong format.
auto_apms_util::exceptions::ResourceErrorif resource cannot be determined using search_identity.
auto_apms_behavior_tree::exceptions::NodeManifestErrorif the resource is not a valid node manifest.

Definition at line 320 of file node_manifest.cpp.

◆ NodeManifestResource() [3/3]

NodeManifestResource ( const char * search_identity)

Constructor of a node manifest resource object.

Parameters
search_identityC-style Nnode manifest resource identity string used for searching the corresponding resource.
Exceptions
auto_apms_util::exceptions::ResourceIdentityFormatErrorif search_identity has wrong format.
auto_apms_util::exceptions::ResourceErrorif resource cannot be determined using search_identity.
auto_apms_behavior_tree::exceptions::NodeManifestErrorif the resource is not a valid node manifest.

Definition at line 325 of file node_manifest.cpp.

Member Function Documentation

◆ getIdentity()

const NodeManifestResource::Identity & getIdentity ( ) const

Get the unique identity for this resource.

Returns
Identity object.

Definition at line 330 of file node_manifest.cpp.

◆ getNodeManifest()

const NodeManifest & getNodeManifest ( ) const

Get the node manifest object associated with this resource.

Returns
Node manifest object.

Definition at line 332 of file node_manifest.cpp.

◆ getNodeModel()

const NodeModelMap & getNodeModel ( ) const

Get the node model object associated with this resource.

Returns
Node model object.

Definition at line 334 of file node_manifest.cpp.


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