Jpp test-rotations-old
the software that should make you happy
Loading...
Searching...
No Matches
JACOUSTICS::JGEOMETRY::JFloor Struct Reference

Floor geometry. More...

#include <JGeometry.hh>

Public Member Functions

 JFloor ()
 Default constructor.
 
 JFloor (const double height, const JVector2D &position=JVector2D())
 Constructor.
 
double getHeight () const
 Get height of this floor.
 
const JVector3DgetPosition () const
 Get position of this floor.
 

Protected Attributes

double height
 
JVector3D position
 

Friends

std::ostream & operator<< (std::ostream &out, const JFloor &floor)
 Write floor parameters to output stream.
 

Detailed Description

Floor geometry.

Definition at line 61 of file JGeometry.hh.

Constructor & Destructor Documentation

◆ JFloor() [1/2]

JACOUSTICS::JGEOMETRY::JFloor::JFloor ( )
inline

Default constructor.

Definition at line 65 of file JGeometry.hh.

65 :
66 height(0.0)
67 {}

◆ JFloor() [2/2]

JACOUSTICS::JGEOMETRY::JFloor::JFloor ( const double height,
const JVector2D & position = JVector2D() )
inline

Constructor.


The height corresponds to the maximal distance from the top of the T-bar of the parent string to the actual sensor.
The optional position corresponds to an anomalous offset of the optical module with respect to its nominal position.

Parameters
heightheight
positionposition

Definition at line 78 of file JGeometry.hh.

78 :
81 {}
double getY() const
Get y position.
Definition JVector3D.hh:104
double getX() const
Get x position.
Definition JVector3D.hh:94

Member Function Documentation

◆ getHeight()

double JACOUSTICS::JGEOMETRY::JFloor::getHeight ( ) const
inline

Get height of this floor.


The height refers to the maximal distance from the fixed reference point of the parent string.

Returns
height

Definition at line 91 of file JGeometry.hh.

92 {
93 return height;
94 }

◆ getPosition()

const JVector3D & JACOUSTICS::JGEOMETRY::JFloor::getPosition ( ) const
inline

Get position of this floor.


The position corresponds to an anomalous offset of the optical module with respect to its nominal position.

Returns
position

Definition at line 103 of file JGeometry.hh.

104 {
105 return position;
106 }

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JFloor & floor )
friend

Write floor parameters to output stream.

Parameters
outoutput stream
floorfloor
Returns
output stream

Definition at line 116 of file JGeometry.hh.

117 {
118 return out << FIXED(7,2) << floor.getHeight();
119 }
Auxiliary data structure for floating point format specification.
Definition JManip.hh:448

Member Data Documentation

◆ height

double JACOUSTICS::JGEOMETRY::JFloor::height
protected

Definition at line 123 of file JGeometry.hh.

◆ position

JVector3D JACOUSTICS::JGEOMETRY::JFloor::position
protected

Definition at line 124 of file JGeometry.hh.


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