HerdSoftware  0.1.1
Classes | Namespaces | Enumerations | Functions | Variables
RefFrame.h File Reference
#include <array>
#include <stdexcept>
#include <string>

Go to the source code of this file.

Classes

struct  Herd::RefFrame::Ortog< T >
 Base struct to get the two axes orthogonal to a direction. More...
 
struct  Herd::RefFrame::Ortog< RefFrame::Axis::X >
 
struct  Herd::RefFrame::Ortog< RefFrame::Axis::Y >
 
struct  Herd::RefFrame::Ortog< RefFrame::Axis::Z >
 
struct  Herd::RefFrame::ViewAxes< T >
 Base struct to get the two axes of a given view. More...
 
struct  Herd::RefFrame::ViewAxes< RefFrame::View::YZ >
 
struct  Herd::RefFrame::ViewAxes< RefFrame::View::XZ >
 
struct  Herd::RefFrame::ViewAxes< RefFrame::View::XY >
 

Namespaces

 Herd
 CssGeoParams.h CssGeoParams class declaration.
 
 Herd::RefFrame
 

Enumerations

enum  Herd::RefFrame::Coo : int { Herd::RefFrame::Coo::NONE = -1, Herd::RefFrame::Coo::X = 0, Herd::RefFrame::Coo::Y = 1, Herd::RefFrame::Coo::Z = 2 }
 Aliases for the three space coordinates. RefFrame.h common/RefFrame.h. More...
 
enum  Herd::RefFrame::Axis : int { Herd::RefFrame::Axis::NONE = -1, Herd::RefFrame::Axis::X = 0, Herd::RefFrame::Axis::Y = 1, Herd::RefFrame::Axis::Z = 2 }
 Aliases for the axes. RefFrame.h common/RefFrame.h. More...
 
enum  Herd::RefFrame::Direction : int {
  Herd::RefFrame::Direction::NONE = -1, Herd::RefFrame::Direction::Xpos = 0, Herd::RefFrame::Direction::Xneg = 1, Herd::RefFrame::Direction::Ypos = 2,
  Herd::RefFrame::Direction::Yneg = 3, Herd::RefFrame::Direction::Zpos = 4, Herd::RefFrame::Direction::Zneg = 5, Herd::RefFrame::Direction::XnegYneg = 6,
  Herd::RefFrame::Direction::XposYneg = 7, Herd::RefFrame::Direction::XnegYpos = 8, Herd::RefFrame::Direction::XposYpos = 9
}
 Aliases for the six axis directions. RefFrame.h common/RefFrame.h. More...
 
enum  Herd::RefFrame::View : int { Herd::RefFrame::View::NONE = -1, Herd::RefFrame::View::XY = 0, Herd::RefFrame::View::XZ = 1, Herd::RefFrame::View::YZ = 2 }
 Aliases for the three 2D projection planes. RefFrame.h common/RefFrame.h. More...
 
enum  Herd::RefFrame::Side : int {
  Herd::RefFrame::Side::NONE = -1, Herd::RefFrame::Side::Xpos = 0, Herd::RefFrame::Side::Xneg = 1, Herd::RefFrame::Side::Ypos = 2,
  Herd::RefFrame::Side::Yneg = 3, Herd::RefFrame::Side::TOP = 4
}
 Aliases for the five sides. RefFrame.h common/RefFrame.h. More...
 

Functions

std::ostream & Herd::RefFrame::operator<< (std::ostream &out, const Axis &axis)
 
std::string Herd::RefFrame::operator+ (const std::string &str, const Axis &axis)
 
std::ostream & Herd::RefFrame::operator<< (std::ostream &out, const Direction &direction)
 
std::string Herd::RefFrame::operator+ (const std::string &str, const Direction &direction)
 
std::ostream & Herd::RefFrame::operator<< (std::ostream &out, const Side &side)
 
std::string Herd::RefFrame::operator+ (const std::string &str, const Side &side)
 
Coo Herd::RefFrame::ToCoo (Axis axis)
 Associates a coordinate to an axis. More...
 
Axis Herd::RefFrame::ToAxis (Coo coo)
 Associates an axis to a coordinate . More...
 
Axis Herd::RefFrame::ToAxis (Direction dir)
 
Coo Herd::RefFrame::ToCoo (Direction direction)
 Associates a coordinate to a direction. More...
 
Axis Herd::RefFrame::NormalAxis (Side side)
 
Axis Herd::RefFrame::NormalAxis (View view)
 
Direction Herd::RefFrame::NormalDirection (Side side)
 
Axis Herd::RefFrame::NormalAxis (Axis ax1, Axis ax2)
 Given two axes get the third one ;) More...
 
bool Herd::RefFrame::IsPositive (Direction dir)
 Tells if a direction is positive or not. More...
 

Variables

constexpr std::array< Coo, 3 > Herd::RefFrame::Coos {Coo::X, Coo::Y, Coo::Z}
 
constexpr int Herd::RefFrame::NAxes = 3
 The number of axes (i.e. (number of elements of Axis) - 1). More...
 
constexpr std::array< Axis, NAxes > Herd::RefFrame::Axes {Axis::X, Axis::Y, Axis::Z}
 Array of all the axes. More...
 
const std::array< std::string, NAxes > Herd::RefFrame::AxisName {"X", "Y", "Z"}
 
constexpr int Herd::RefFrame::NDirections = 10
 The number of directions (i.e. (number of elements of Direction) - 1). More...
 
constexpr std::array< RefFrame::Direction, RefFrame::NDirections > Herd::RefFrame::Directions
 
const std::array< std::string, RefFrame::NDirections > Herd::RefFrame::DirectionName
 
constexpr int Herd::RefFrame::NViews = 3
 The number of views (i.e. (number of elements of View) - 1). More...
 
constexpr std::array< View, NViews > Herd::RefFrame::Views {View::XY, View::XZ, View::YZ}
 Array of all the views. More...
 
const std::array< std::string, NViews > Herd::RefFrame::ViewName {"XY", "XZ", "YZ"}
 
constexpr int Herd::RefFrame::NSides = 5
 The number of sides (i.e. (number of elements of Side) - 1). More...
 
constexpr std::array< Side, NSides > Herd::RefFrame::Sides {Side::Xpos, Side::Xneg, Side::Ypos, Side::Yneg, Side::TOP}
 Array of all the sides. More...
 
const std::array< std::string, NSides > Herd::RefFrame::SideName {"Xpos", "Xneg", "Ypos", "Yneg", "TOP"}
 

Detailed Description

Declaration of reference-frame related quantities.