Skip to content
Snippets Groups Projects
Commit 2c70794f authored by Joan Solà Ortega's avatar Joan Solà Ortega
Browse files

Fix documentation of emplaceFrame()

parent 5e84cc9a
No related branches found
No related tags found
1 merge request!366Resolve "Complete state vector new data structure?"
Pipeline #5450 passed
...@@ -209,11 +209,11 @@ class Problem : public std::enable_shared_from_this<Problem> ...@@ -209,11 +209,11 @@ class Problem : public std::enable_shared_from_this<Problem>
const double &_time_tol); const double &_time_tol);
/** \brief Emplace frame from string frame_structure /** \brief Emplace frame from string frame_structure
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _time_stamp Time stamp of the frame
* \param _frame_structure String indicating the frame structure. * \param _frame_structure String indicating the frame structure.
* \param _dim variable indicating the dimension of the problem * \param _dim variable indicating the dimension of the problem
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _frame_state State vector; must match the size and format of the chosen frame structure * \param _frame_state State vector; must match the size and format of the chosen frame structure
* \param _time_stamp Time stamp of the frame
* *
* This acts as a Frame factory, but also takes care to update related lists in WolfProblem: * This acts as a Frame factory, but also takes care to update related lists in WolfProblem:
* - Create a Frame * - Create a Frame
...@@ -227,11 +227,10 @@ class Problem : public std::enable_shared_from_this<Problem> ...@@ -227,11 +227,10 @@ class Problem : public std::enable_shared_from_this<Problem>
const Eigen::VectorXd& _frame_state); const Eigen::VectorXd& _frame_state);
/** \brief Emplace frame from string frame_structure /** \brief Emplace frame from string frame_structure
* \param _frame_structure String indicating the frame structure.
* \param _dim variable indicating the dimension of the problem
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED * \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _frame_state State vector; must match the size and format of the chosen frame structure
* \param _time_stamp Time stamp of the frame * \param _time_stamp Time stamp of the frame
* \param _frame_structure String indicating the frame structure.
* \param _frame_state State vector; must match the size and format of the chosen frame structure
* *
* This acts as a Frame factory, but also takes care to update related lists in WolfProblem: * This acts as a Frame factory, but also takes care to update related lists in WolfProblem:
* - Create a Frame * - Create a Frame
...@@ -242,15 +241,26 @@ class Problem : public std::enable_shared_from_this<Problem> ...@@ -242,15 +241,26 @@ class Problem : public std::enable_shared_from_this<Problem>
const TimeStamp& _time_stamp, // const TimeStamp& _time_stamp, //
const StateStructure& _frame_structure, // const StateStructure& _frame_structure, //
const VectorComposite& _frame_state); const VectorComposite& _frame_state);
/** \brief Emplace frame from string frame_structure
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _time_stamp Time stamp of the frame
* \param _frame_state State; must be part of the problem's frame structure
*
* This acts as a Frame factory, but also takes care to update related lists in WolfProblem:
* - Create a Frame
* - Add it to Trajectory
* - If it is key-frame, update state-block lists in Problem
*/
FrameBasePtr emplaceFrame(FrameType _frame_key_type, // FrameBasePtr emplaceFrame(FrameType _frame_key_type, //
const TimeStamp& _time_stamp, // const TimeStamp& _time_stamp, //
const VectorComposite& _frame_state); const VectorComposite& _frame_state);
/** \brief Emplace frame from string frame_structure without state /** \brief Emplace frame from string frame_structure without state
* \param _frame_structure String indicating the frame structure.
* \param _dim variable indicating the dimension of the problem
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED * \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _time_stamp Time stamp of the frame * \param _time_stamp Time stamp of the frame
* \param _frame_structure String indicating the frame structure.
* \param _dim variable indicating the dimension of the problem
* *
* This acts as a Frame factory, but also takes care to update related lists in WolfProblem: * This acts as a Frame factory, but also takes care to update related lists in WolfProblem:
* - Create a Frame * - Create a Frame
...@@ -264,8 +274,8 @@ class Problem : public std::enable_shared_from_this<Problem> ...@@ -264,8 +274,8 @@ class Problem : public std::enable_shared_from_this<Problem>
/** \brief Emplace frame from string frame_structure without structure /** \brief Emplace frame from string frame_structure without structure
* \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED * \param _frame_key_type Either KEY, AUXILIARY or NON_ESTIMATED
* \param _frame_state State vector; must match the size and format of the chosen frame structure
* \param _time_stamp Time stamp of the frame * \param _time_stamp Time stamp of the frame
* \param _frame_state State vector; must match the size and format of the chosen frame structure
* *
* This acts as a Frame factory, but also takes care to update related lists in WolfProblem: * This acts as a Frame factory, but also takes care to update related lists in WolfProblem:
* - Create a Frame * - Create a Frame
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment