WorldBuilder::CoordinateSystems::Cartesian Class Reference

#include <cartesian.h>

Inheritance diagram for WorldBuilder::CoordinateSystems::Cartesian:

Collaboration diagram for WorldBuilder::CoordinateSystems::Cartesian:

Public Member Functions
	Cartesian ()
	~Cartesian ()
virtual void	decare_entries (std::string &path)
virtual CoordinateSystem	natural_coordinate_system () const
virtual std::array< double, 3 >	cartesian_to_natural_coordinates (const std::array< double, 3 > &position) const
virtual std::array< double, 3 >	natural_to_cartesian_coordinates (const std::array< double, 3 > &position) const
Public Member Functions inherited from WorldBuilder::CoordinateSystems::Interface
	Interface ()
virtual	~Interface ()

Detailed Description

This implements a Cartesian geometry model.The Cartesian geometry model doesn't do anything with the coordinates, but is needed to have a common interface for all the geometry models.

Definition at line 37 of file cartesian.h.

Constructor & Destructor Documentation

Cartesian()

WorldBuilder::CoordinateSystems::Cartesian::Cartesian

(

)

constructor

Definition at line 26 of file cartesian.cc.

~Cartesian()

WorldBuilder::CoordinateSystems::Cartesian::~Cartesian

(

)

Destructor

Definition at line 29 of file cartesian.cc.

Member Function Documentation

cartesian_to_natural_coordinates()

std::array< double, 3 > WorldBuilder::CoordinateSystems::Cartesian::cartesian_to_natural_coordinates ( const std::array< double, 3 > &  position ) const

virtual

Takes the Cartesian points (x,z or x,y,z) and returns standardized coordinates which are most 'natural' to the geometry model. For a box this will be (x,z) in 2d or (x,y,z) in 3d, and for a spheroid geometry model it will be (radius, longitude) in 2d and (radius, longitude, latitude) in 3d.

Implements WorldBuilder::CoordinateSystems::Interface.

Definition at line 45 of file cartesian.cc.

decare_entries()

void WorldBuilder::CoordinateSystems::Cartesian::decare_entries ( std::string &  path )

virtual

Read in the world builder file

Implements WorldBuilder::CoordinateSystems::Interface.

Definition at line 33 of file cartesian.cc.

natural_coordinate_system()

CoordinateSystem WorldBuilder::CoordinateSystems::Cartesian::natural_coordinate_system ( ) const

virtual

Returns what the natural coordinate system for this Coordinate System is.

Implements WorldBuilder::CoordinateSystems::Interface.

Definition at line 38 of file cartesian.cc.

natural_to_cartesian_coordinates()

std::array< double, 3 > WorldBuilder::CoordinateSystems::Cartesian::natural_to_cartesian_coordinates ( const std::array< double, 3 > &  position ) const

virtual

Undoes the action of cartesian_to_natural_coordinates, and turns the coordinate system which is most 'natural' to the geometry model into Cartesian coordinates.

Implements WorldBuilder::CoordinateSystems::Interface.

Definition at line 52 of file cartesian.cc.

---

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

• include/world_builder/coordinate_systems/cartesian.h
• source/coordinate_system/cartesian.cc