The fitted helix trajectory pattern. More...
#include <falaise/snemo/datamodels/helix_trajectory_pattern.h>
Inheritance diagram for snemo::datamodel::helix_trajectory_pattern:
Public Member Functions | |
| helix_trajectory_pattern () | |
| Default constructor. More... | |
| virtual | ~helix_trajectory_pattern () |
| Destructor. More... | |
| geomtools::helix_3d & | grab_helix () |
| Get a reference to the mutable helix embedded model. More... | |
| const geomtools::helix_3d & | get_helix () const |
| Get a reference to the non mutable helix embedded model. More... | |
| virtual const geomtools::i_shape_1d & | get_shape () const |
| Return the reference to the 1D shape associated to the trajectory. More... | |
 Public Member Functions inherited from snemo::datamodel::base_trajectory_pattern | |
| bool | has_pattern_id () const |
| Check if a valid pattern ID exists. More... | |
| const std::string & | get_pattern_id () const |
| Return the pattern ID. More... | |
| base_trajectory_pattern (const std::string &pattern_id_="") | |
| Constructor. More... | |
| virtual | ~base_trajectory_pattern () |
| Destructor. More... | |
| Public Member Functions inherited from datatools::i_serializable | |
| i_serializable () | |
| virtual | ~i_serializable () |
| virtual const std::string & | get_serial_tag () const=0 |
Static Public Member Functions | |
| static const std::string & | pattern_id () |
| Return pattern identifier of the pattern. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from snemo::datamodel::base_trajectory_pattern | |
| void | _set_pattern_id (const std::string &pattern_id_) |
| Set the pattern ID. More... | |
Detailed Description
The fitted helix trajectory pattern.
Constructor & Destructor Documentation
◆ helix_trajectory_pattern()
| snemo::datamodel::helix_trajectory_pattern::helix_trajectory_pattern | ( | ) |
Default constructor.
◆ ~helix_trajectory_pattern()
|
virtual |
Destructor.
Member Function Documentation
◆ get_helix()
| const geomtools::helix_3d& snemo::datamodel::helix_trajectory_pattern::get_helix | ( | ) | const |
Get a reference to the non mutable helix embedded model.
◆ get_shape()
|
virtual |
Return the reference to the 1D shape associated to the trajectory.
Implements snemo::datamodel::base_trajectory_pattern.
◆ grab_helix()
| geomtools::helix_3d& snemo::datamodel::helix_trajectory_pattern::grab_helix | ( | ) |
Get a reference to the mutable helix embedded model.
◆ pattern_id()
|
static |
Return pattern identifier of the pattern.
The documentation for this class was generated from the following file:
- falaise/snemo/datamodels/helix_trajectory_pattern.h
