TrajectoryDiagnosticColumn Class Reference

Class for trajectory diagnostic data column. More...

#include <trajectorydiagnostics.hpp>

Public Member Functions
	TrajectoryDiagnosticColumn (trajectory_diagnostic_e diag)
	Create new diagnostic data column with type diag. More...
void	mirror (coordinate_axis_e axis, double level)
	Add mirrored trajectory diagnostic data to the column. More...
void	add_data (double x)
	Add diagnostic data point to column. More...
std::vector< double > &	data (void)
	Get a reference to diagnostic data vector. More...
const std::vector< double > &	data (void) const
	Get a const reference to diagnostic data vector. More...
size_t	size (void) const
	Get size of diagnostic data vector. More...
trajectory_diagnostic_e	diagnostic (void) const
	Get diagnostic type. More...
const double &	operator() (size_t i) const
	Get const reference to data element i. More...
double &	operator() (size_t i)
	Get reference to data element i. More...
const double &	operator[] (size_t i) const
	Get const reference to data element i. More...
double &	operator[] (size_t i)
	Get reference to data element i. More...

Detailed Description

Class for trajectory diagnostic data column.

Contains one specified (trajectory_diagnostic_e) type of diagnostic data for N trajectories as a vector. TrajectoryDiagnosticColumns are used in class TrajectoryDiagnosticData to store different types of diagnostic data and type information.

Constructor & Destructor Documentation

TrajectoryDiagnosticColumn()

TrajectoryDiagnosticColumn::TrajectoryDiagnosticColumn ( trajectory_diagnostic_e  diag )

inline

Create new diagnostic data column with type diag.

Member Function Documentation

add_data()

void TrajectoryDiagnosticColumn::add_data ( double  x )

inline

Add diagnostic data point to column.

data() [1/2]

std::vector<double>& TrajectoryDiagnosticColumn::data ( void  )

inline

Get a reference to diagnostic data vector.

data() [2/2]

const std::vector<double>& TrajectoryDiagnosticColumn::data ( void  ) const

inline

Get a const reference to diagnostic data vector.

diagnostic()

trajectory_diagnostic_e TrajectoryDiagnosticColumn::diagnostic ( void  ) const

inline

Get diagnostic type.

mirror()

void TrajectoryDiagnosticColumn::mirror	(	coordinate_axis_e	axis,
		double	level
	)

Add mirrored trajectory diagnostic data to the column.

Mirror data along plane axis = level. The mirrored data is added to the data column. This function is used to get a complete data set of a particle beam, of which only half (or quarter) has been simulated.

operator()() [1/2]

double& TrajectoryDiagnosticColumn::operator() ( size_t  i )

inline

Get reference to data element i.

operator()() [2/2]

const double& TrajectoryDiagnosticColumn::operator() ( size_t  i ) const

inline

Get const reference to data element i.

operator[]() [1/2]

double& TrajectoryDiagnosticColumn::operator[] ( size_t  i )

inline

Get reference to data element i.

operator[]() [2/2]

const double& TrajectoryDiagnosticColumn::operator[] ( size_t  i ) const

inline

Get const reference to data element i.

size()

size_t TrajectoryDiagnosticColumn::size ( void  ) const

inline

Get size of diagnostic data vector.

---

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

• trajectorydiagnostics.hpp
• trajectorydiagnostics.cpp