WorldBuilder::CoordinateSystems::Interface Class Reference

#include <interface.h>

Inheritance diagram for WorldBuilder::CoordinateSystems::Interface:

Public Member Functions
	Interface ()
virtual	~Interface ()
virtual void	decare_entries (std::string &path)=0
virtual CoordinateSystem	natural_coordinate_system () const =0
virtual std::array< double, 3 >	cartesian_to_natural_coordinates (const std::array< double, 3 > &position) const =0
virtual std::array< double, 3 >	natural_to_cartesian_coordinates (const std::array< double, 3 > &position) const =0

Detailed Description

Definition at line 36 of file interface.h.

Constructor & Destructor Documentation

Interface()

WorldBuilder::CoordinateSystems::Interface::Interface

(

)

constructor

Definition at line 31 of file interface.cc.

~Interface()

WorldBuilder::CoordinateSystems::Interface::~Interface ( )

virtual

Destructor

Definition at line 34 of file interface.cc.

Member Function Documentation

cartesian_to_natural_coordinates()

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

pure 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.

Implemented in WorldBuilder::CoordinateSystems::Cartesian.

Here is the caller graph for this function:

decare_entries()

virtual void WorldBuilder::CoordinateSystems::Interface::decare_entries ( std::string &  path )

pure virtual

read in the world builder file

Implemented in WorldBuilder::CoordinateSystems::Cartesian.

natural_coordinate_system()

virtual CoordinateSystem WorldBuilder::CoordinateSystems::Interface::natural_coordinate_system ( ) const

pure virtual

Returns what the natural coordinate system for this geometry model is.

Implemented in WorldBuilder::CoordinateSystems::Cartesian.

Here is the caller graph for this function:

natural_to_cartesian_coordinates()

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

pure 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.

Implemented in WorldBuilder::CoordinateSystems::Cartesian.

---

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

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