Public Member Functions | Private Attributes | List of all members
fuse_core::GraphDeserializer Class Reference

Deserialize a graph. More...

#include <graph_deserializer.h>

Public Member Functions

fuse_core::Graph::UniquePtr deserialize (const fuse_msgs::SerializedGraph &msg) const
 Deserialize a SerializedGraph message into a fuse Graph object. More...
 
fuse_core::Graph::UniquePtr deserialize (const fuse_msgs::SerializedGraph::ConstPtr &msg) const
 Deserialize a SerializedGraph message into a fuse Graph object. More...
 
 GraphDeserializer ()
 Constructor. More...
 

Private Attributes

pluginlib::ClassLoader< fuse_core::Constraintconstraint_loader_
 Pluginlib class loader for Constraint types. More...
 
pluginlib::ClassLoader< fuse_core::Graphgraph_loader_
 Pluginlib class loader for Graph types. More...
 
pluginlib::ClassLoader< fuse_core::Lossloss_loader_
 Pluginlib class loader for Loss types. More...
 
pluginlib::ClassLoader< fuse_core::Variablevariable_loader_
 Pluginlib class loader for Variable types. More...
 

Detailed Description

Deserialize a graph.

The deserializer object loads all of the known Variable and Constraint libraries, allowing derived types contained within the graph to be properly deserialized. The libraries will be unloaded on destruction. As a consequence, the deserializer object must outlive any created graph instances.

Definition at line 59 of file graph_deserializer.h.

Constructor & Destructor Documentation

◆ GraphDeserializer()

fuse_core::GraphDeserializer::GraphDeserializer ( )

Constructor.

Definition at line 58 of file graph_deserializer.cpp.

Member Function Documentation

◆ deserialize() [1/2]

fuse_core::Graph::UniquePtr fuse_core::GraphDeserializer::deserialize ( const fuse_msgs::SerializedGraph &  msg) const

Deserialize a SerializedGraph message into a fuse Graph object.

If no plugin is available for a contained Variable or Constraint, or an error occurs during deserialization, an exception is thrown.

Parameters
[in]msgThe SerializedGraph message to be deserialized
Returns
A unique_ptr to a derived Graph object

Definition at line 86 of file graph_deserializer.cpp.

◆ deserialize() [2/2]

fuse_core::Graph::UniquePtr fuse_core::GraphDeserializer::deserialize ( const fuse_msgs::SerializedGraph::ConstPtr &  msg) const

Deserialize a SerializedGraph message into a fuse Graph object.

If no plugin is available for a contained Variable or Constraint, or an error occurs during deserialization, an exception is thrown.

Parameters
[in]msgThe SerializedGraph message to be deserialized
Returns
A unique_ptr to a derived Graph object

Definition at line 81 of file graph_deserializer.cpp.

Member Data Documentation

◆ constraint_loader_

pluginlib::ClassLoader<fuse_core::Constraint> fuse_core::GraphDeserializer::constraint_loader_
private

Pluginlib class loader for Constraint types.

Definition at line 91 of file graph_deserializer.h.

◆ graph_loader_

pluginlib::ClassLoader<fuse_core::Graph> fuse_core::GraphDeserializer::graph_loader_
mutableprivate

Pluginlib class loader for Graph types.

Definition at line 95 of file graph_deserializer.h.

◆ loss_loader_

pluginlib::ClassLoader<fuse_core::Loss> fuse_core::GraphDeserializer::loss_loader_
private

Pluginlib class loader for Loss types.

Definition at line 92 of file graph_deserializer.h.

◆ variable_loader_

pluginlib::ClassLoader<fuse_core::Variable> fuse_core::GraphDeserializer::variable_loader_
private

Pluginlib class loader for Variable types.

Definition at line 90 of file graph_deserializer.h.


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


fuse_core
Author(s): Stephen Williams
autogenerated on Thu Apr 24 2025 02:18:55