Falaise  4.0.1
SuperNEMO Software Toolkit
Public Member Functions | Protected Member Functions | List of all members
snemo::datamodel::base_trajectory_pattern Class Referenceabstract

The base class of fitted trajectory pattern. More...

#include <falaise/snemo/datamodels/base_trajectory_pattern.h>

Inheritance diagram for snemo::datamodel::base_trajectory_pattern:
datatools::i_serializable snemo::datamodel::helix_trajectory_pattern snemo::datamodel::line_trajectory_pattern snemo::datamodel::polyline_trajectory_pattern

Public Member Functions

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...
 
virtual const geomtools::i_shape_1dget_shape () const =0
 Return the reference to the 1D shape associated to the trajectory. 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
 

Protected Member Functions

void _set_pattern_id (const std::string &pattern_id_)
 Set the pattern ID. More...
 

Detailed Description

The base class of fitted trajectory pattern.

Constructor & Destructor Documentation

◆ base_trajectory_pattern()

snemo::datamodel::base_trajectory_pattern::base_trajectory_pattern ( const std::string &  pattern_id_ = "")

Constructor.

◆ ~base_trajectory_pattern()

virtual snemo::datamodel::base_trajectory_pattern::~base_trajectory_pattern ( )
virtual

Destructor.

Member Function Documentation

◆ _set_pattern_id()

void snemo::datamodel::base_trajectory_pattern::_set_pattern_id ( const std::string &  pattern_id_)
protected

Set the pattern ID.

◆ get_pattern_id()

const std::string& snemo::datamodel::base_trajectory_pattern::get_pattern_id ( ) const

Return the pattern ID.

◆ get_shape()

virtual const geomtools::i_shape_1d& snemo::datamodel::base_trajectory_pattern::get_shape ( ) const
pure virtual

Return the reference to the 1D shape associated to the trajectory.

Implemented in snemo::datamodel::helix_trajectory_pattern, snemo::datamodel::line_trajectory_pattern, and snemo::datamodel::polyline_trajectory_pattern.

◆ has_pattern_id()

bool snemo::datamodel::base_trajectory_pattern::has_pattern_id ( ) const

Check if a valid pattern ID exists.


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