EZC3D
Public Member Functions | Protected Attributes | List of all members
ezc3d::DataNS::Points3dNS::Point Class Reference

3D point data More...

#include <Point.h>

Public Member Functions

 Point ()
 Create an empty 3D point with memory allocated but not filled.
 
 Point (const ezc3d::DataNS::Points3dNS::Point &point)
 Copy a 3D point. More...
 
void print () const
 Print the point. More...
 
void write (std::fstream &f) const
 Write the point to an opened file. More...
 
const std::vector< float > data () const
 Get a reference to the STL vector where the 3D point is store. More...
 
std::vector< float > data_nonConst ()
 Get a reference to the STL vector where the 3D point is store in order to be modified by the caller. More...
 
float x () const
 Get the X component of the 3D point. More...
 
void x (float x)
 Set the X component of the 3D point. More...
 
float y () const
 Get the Y component of the 3D point. More...
 
void y (float y)
 Set the Y component of the 3D point. More...
 
float z () const
 Get the Z component of the 3D point. More...
 
void z (float z)
 Set the Z component of the 3D point. More...
 
float residual () const
 Get the residual component of the 3D point. More...
 
void residual (float residual)
 Set the residualZ component of the 3D point. More...
 
bool isempty () const
 Return if the point is empty. More...
 

Protected Attributes

std::vector< float > _data
 Value of the point.
 

Detailed Description

3D point data

Definition at line 16 of file Point.h.

Constructor & Destructor Documentation

◆ Point()

ezc3d::DataNS::Points3dNS::Point::Point ( const ezc3d::DataNS::Points3dNS::Point point)

Copy a 3D point.

Parameters
pointThe point to copy

Definition at line 17 of file Point.cpp.

Member Function Documentation

◆ data()

const std::vector< float > ezc3d::DataNS::Points3dNS::Point::data ( ) const

Get a reference to the STL vector where the 3D point is store.

Returns
The 3d point

Definition at line 39 of file Point.cpp.

◆ data_nonConst()

std::vector< float > ezc3d::DataNS::Points3dNS::Point::data_nonConst ( )

Get a reference to the STL vector where the 3D point is store in order to be modified by the caller.

Returns
The 3d point

Get a reference to the STL vector where the 3D point is store in the form of a non-const reference. The user can thereafter modify these points at will, but with the caution it requires.

Definition at line 44 of file Point.cpp.

◆ isempty()

bool ezc3d::DataNS::Points3dNS::Point::isempty ( ) const

Return if the point is empty.

Returns
if the point is empty

Definition at line 89 of file Point.cpp.

◆ print()

void ezc3d::DataNS::Points3dNS::Point::print ( ) const

Print the point.

Print the values of the point to the console

Definition at line 26 of file Point.cpp.

◆ residual() [1/2]

float ezc3d::DataNS::Points3dNS::Point::residual ( ) const

Get the residual component of the 3D point.

Returns
The residual component of the 3d point

Definition at line 80 of file Point.cpp.

◆ residual() [2/2]

void ezc3d::DataNS::Points3dNS::Point::residual ( float  residual)

Set the residualZ component of the 3D point.

Parameters
residualThe residual component of the 3d point

Definition at line 85 of file Point.cpp.

◆ write()

void ezc3d::DataNS::Points3dNS::Point::write ( std::fstream &  f) const

Write the point to an opened file.

Parameters
fAlready opened fstream file with write access

Write the values of the point to a file

Definition at line 31 of file Point.cpp.

◆ x() [1/2]

float ezc3d::DataNS::Points3dNS::Point::x ( ) const

Get the X component of the 3D point.

Returns
The X component of the 3d point

Definition at line 49 of file Point.cpp.

◆ x() [2/2]

void ezc3d::DataNS::Points3dNS::Point::x ( float  x)

Set the X component of the 3D point.

Parameters
xThe X component of the 3d point

Definition at line 54 of file Point.cpp.

◆ y() [1/2]

float ezc3d::DataNS::Points3dNS::Point::y ( ) const

Get the Y component of the 3D point.

Returns
The Y component of the 3d point

Definition at line 59 of file Point.cpp.

◆ y() [2/2]

void ezc3d::DataNS::Points3dNS::Point::y ( float  y)

Set the Y component of the 3D point.

Parameters
yThe Y component of the 3d point

Definition at line 64 of file Point.cpp.

◆ z() [1/2]

float ezc3d::DataNS::Points3dNS::Point::z ( ) const

Get the Z component of the 3D point.

Returns
The Z component of the 3d point

Definition at line 69 of file Point.cpp.

◆ z() [2/2]

void ezc3d::DataNS::Points3dNS::Point::z ( float  z)

Set the Z component of the 3D point.

Parameters
zThe Z component of the 3d point

Definition at line 74 of file Point.cpp.


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