CbmRoot
Loading...
Searching...
No Matches
GeoVolume::Dimension Struct Reference

A volume dimension representation. More...

Public Member Functions

 Dimension ()=default
 Default constructor.
 
 Dimension (double lo_, double up_)
 Constructor.
 
Dimensionoperator+= (const Dimension &other)
 Compound assignment of another dimension.
 
double Center () const
 Center of the dimension.
 
bool IsValid () const
 Checks, if the dimension is valid.
 
bool HasOverlapWith (const Dimension &other) const
 Checks, if the dimension has an overlap with another dimension.
 
double Size () const
 Size of the dimension.
 

Public Attributes

double lo {+std::numeric_limits<double>::max()}
 Lower bound of the dimension.
 
double up {-std::numeric_limits<double>::max()}
 Upper bound of the dimension.
 

Detailed Description

A volume dimension representation.

Definition at line 28 of file GeoVolume.h.

Constructor & Destructor Documentation

◆ Dimension() [1/2]

cbm::algo::GeoVolume::Dimension::Dimension ( )
default

Default constructor.

◆ Dimension() [2/2]

cbm::algo::GeoVolume::Dimension::Dimension ( double lo_,
double up_ )
inline

Constructor.

Definition at line 36 of file GeoVolume.h.

Member Function Documentation

◆ Center()

double cbm::algo::GeoVolume::Dimension::Center ( ) const
inline

Center of the dimension.

Definition at line 47 of file GeoVolume.h.

◆ HasOverlapWith()

bool cbm::algo::GeoVolume::Dimension::HasOverlapWith ( const Dimension & other) const
inline

Checks, if the dimension has an overlap with another dimension.

Parameters
otherOther dimension

Definition at line 54 of file GeoVolume.h.

◆ IsValid()

bool cbm::algo::GeoVolume::Dimension::IsValid ( ) const
inline

Checks, if the dimension is valid.

Definition at line 50 of file GeoVolume.h.

◆ operator+=()

Dimension & cbm::algo::GeoVolume::Dimension::operator+= ( const Dimension & other)
inline

Compound assignment of another dimension.

Definition at line 39 of file GeoVolume.h.

◆ Size()

double cbm::algo::GeoVolume::Dimension::Size ( ) const
inline

Size of the dimension.

Definition at line 57 of file GeoVolume.h.

Member Data Documentation

◆ lo

double cbm::algo::GeoVolume::Dimension::lo {+std::numeric_limits<double>::max()}

Lower bound of the dimension.

Definition at line 29 of file GeoVolume.h.

◆ up

double cbm::algo::GeoVolume::Dimension::up {-std::numeric_limits<double>::max()}

Upper bound of the dimension.

Definition at line 30 of file GeoVolume.h.


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