NodeManifestResourceIdentity Struct Reference

Struct that encapsulates the identity string for a registered behavior tree node manifest. More...

#include <auto_apms_behavior_tree_core/node/node_manifest.hpp>

Public Member Functions
	NodeManifestResourceIdentity (const std::string &identity)
	Constructor of a node manifest resource identity object.
	NodeManifestResourceIdentity (const char *identity)
	Constructor of a behavior resource identity object.
	NodeManifestResourceIdentity ()=default
	Constructor of an empty node manifest resource identity object.
std::string	str () const
	Create the corresponding identity string.
bool	empty () const
	Determine whether this node manifest resource identity object is considered empty.

Public Attributes
std::string	package_name
	Name of the package that registers the behavior resource.
std::string	metadata_id
	Metadata ID determined when regitering the corresponding node manifest resource.

Detailed Description

Struct that encapsulates the identity string for a registered behavior tree node manifest.

Definition at line 31 of file node_manifest.hpp.

Constructor & Destructor Documentation

NodeManifestResourceIdentity() [1/3]

NodeManifestResourceIdentity

(

const std::string &

identity

)

Constructor of a node manifest resource identity object.

identity must be formatted like <package_name>::<metadata_id>.

Parameters

identity

Identity string for a specific node manifest.

Exceptions

auto_apms_util::exceptions::ResourceIdentityFormatError

if the identity string has wrong format.

Definition at line 27 of file node_manifest.cpp.

NodeManifestResourceIdentity() [2/3]

NodeManifestResourceIdentity

(

const char *

identity

)

Constructor of a behavior resource identity object.

identity must be formatted like <package_name>::<metadata_id>.

Parameters

identity

C-style identity string for a specific node manifest resource.

Exceptions

auto_apms_util::exceptions::ResourceIdentityFormatError

if the identity string has wrong format.

Definition at line 49 of file node_manifest.cpp.

NodeManifestResourceIdentity() [3/3]

NodeManifestResourceIdentity ( )

default

Constructor of an empty node manifest resource identity object.

The user must manually populate the member fields.

Member Function Documentation

str()

std::string str

(

)

const

Create the corresponding identity string.

Returns

Identity string for a node manifest resource.

Definition at line 64 of file node_manifest.cpp.

empty()

bool empty

(

)

const

Determine whether this node manifest resource identity object is considered empty.

Returns

true if none of the member fields are set, false otherwise.

Definition at line 69 of file node_manifest.cpp.

Member Data Documentation

package_name

std::string package_name

Name of the package that registers the behavior resource.

Definition at line 77 of file node_manifest.hpp.

metadata_id

std::string metadata_id

Metadata ID determined when regitering the corresponding node manifest resource.

Definition at line 79 of file node_manifest.hpp.

---

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

• auto_apms_behavior_tree_core/include/auto_apms_behavior_tree_core/node/node_manifest.hpp
• auto_apms_behavior_tree_core/src/node/node_manifest.cpp