UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | List of all members
sim::fdm::Snapshot::Area Class Reference

#include <sim_fdm_snapshot.hpp>

Public Member Functions

 Area ()
 
 Area (const Point2D &top_left_coords, const std::vector< CoordT > &dx_vec, const std::vector< CoordT > &dz_vec)
 
 Area (const Point2D &top_left_coords, const Point2D &bottom_right_coords, const Point2D &coord_steps)
 
const Point2DtopLeftCoords () const
 
const std::vector< CoordT > & stepVec (const CoordsMask &coord) const
 

Protected Attributes

Point2D m_top_left_coords
 
std::vector< CoordT > m_dx_vec
 
std::vector< CoordT > m_dz_vec
 

Detailed Description

Coordinates area of the snapshot.

Constructor & Destructor Documentation

sim::fdm::Snapshot::Area::Area ( )
inline

Default constructor.

sim::fdm::Snapshot::Area::Area ( const Point2D top_left_coords,
const std::vector< CoordT > &  dx_vec,
const std::vector< CoordT > &  dz_vec 
)

Construct area.

Parameters
top_left_coordTop left coordinate of the snapshot.
dx_vecVector of steps along x-direction.
dz_vecVector of steps along z-direction.
sim::fdm::Snapshot::Area::Area ( const Point2D top_left_coords,
const Point2D bottom_right_coords,
const Point2D coord_steps 
)

Construct area (for regular snapshot).

Parameters
top_left_coordTop left coordinate of the snapshot.
bottom_right_coordsBottom right coordinate of the snapshot.
coord_stepsSteps along x and z coordinates.

Member Function Documentation

const std::vector<CoordT>& sim::fdm::Snapshot::Area::stepVec ( const CoordsMask coord) const

Access to coordinate steps.

Parameters
coordCoordinate projection required.
const Point2D& sim::fdm::Snapshot::Area::topLeftCoords ( ) const
inline

Access to coordinates of top left corner of the snapshot.

Member Data Documentation

std::vector<CoordT> sim::fdm::Snapshot::Area::m_dx_vec
protected

Steps along x-direction.

std::vector<CoordT> sim::fdm::Snapshot::Area::m_dz_vec
protected

Steps along z-direction.

Point2D sim::fdm::Snapshot::Area::m_top_left_coords
protected

Top left corner of the snapshot.


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