RSTT: rstt/SLBM/include/GreatCircleFactory.h Source File

RSTT 3.1.0 Regional Seismic Travel Time

GreatCircleFactory.h
Go to the documentation of this file.
1 //- ****************************************************************************
2 //-
3 //- Copyright 2009 National Technology & Engineering Solutions of Sandia, LLC
4 //- (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
5 //- Government retains certain rights in this software.
6 //-
7 //- BSD Open Source License
8 //- All rights reserved.
9 //-
10 //- Redistribution and use in source and binary forms, with or without
11 //- modification, are permitted provided that the following conditions are met:
12 //-
13 //- 1. Redistributions of source code must retain the above copyright notice,
14 //- this list of conditions and the following disclaimer.
15 //-
16 //- 2. Redistributions in binary form must reproduce the above copyright
17 //- notice, this list of conditions and the following disclaimer in the
18 //- documentation and/or other materials provided with the distribution.
19 //-
20 //- 3. Neither the name of the copyright holder nor the names of its
21 //- contributors may be used to endorse or promote products derived from
22 //- this software without specific prior written permission.
23 //-
24 //- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 //- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 //- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 //- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
28 //- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 //- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 //- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 //- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 //- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 //- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 //- POSSIBILITY OF SUCH DAMAGE.
35 //-
36 //- ****************************************************************************
37
38 #ifndef GreatCircleFactory_H
39 #define GreatCircleFactory_H
40
41 #include "GreatCircle.h"
42 #include "GreatCircle_Xn.h"
43 #include "GreatCircle_Xg.h"
44
45 using namespace std;
46
47 // **** _BEGIN SLBM NAMESPACE_ **************************************************
48
49 namespace slbm {
50
51 class Grid;
52
58 class SLBM_EXP_IMP GreatCircleFactory
59 {
60 public:
61
65 GreatCircleFactory();
66
70 ~GreatCircleFactory();
71
89 static GreatCircle* create(
90 const int& phase,
91 Grid* grid,
92 const double& latSource,
93 const double& lonSource,
94 const double& depthSource,
95 const double& latReceiver,
96 const double& lonReceiver,
97 const double& depthReceiver,
98 const double& chMax
99 );
100
101 private:
102
103 };
104
105 } // end slbm namespace
106
107 #endif // GreatCircleFactory_H
GreatCircle.h
slbm::GreatCircleFactory::GreatCircleFactory
GreatCircleFactory()
Default constructor.
GreatCircle_Xg.h
slbm::Grid
A 2 dimensional, horizontal grid of GirdProfile objects.
Definition: Grid.h:90
slbm::GreatCircleFactory::create
static GreatCircle * create(const int &phase, Grid *grid, const double &latSource, const double &lonSource, const double &depthSource, const double &latReceiver, const double &lonReceiver, const double &depthReceiver, const double &chMax)
Create the appropriate type of GreatCircle object for the specified phase.
slbm::GreatCircleFactory
A factory class that will return the correct type of GreatCircle object for the specified phase.
Definition: GreatCircleFactory.h:59
SLBM_EXP_IMP
#define SLBM_EXP_IMP
Definition: SLBMGlobals.h:180
slbm::GreatCircleFactory::~GreatCircleFactory
~GreatCircleFactory()
Destructor.
GreatCircle_Xn.h
slbm::GreatCircle
The GreatCircle class manages information related to a great circle path between two Locations on the...
Definition: GreatCircle.h:115
slbm
Definition: CrustalProfile.h:59