CEExecOptions Class Reference

Definition at line 9 of file CEExecOptions.h.

Public Member Functions
void	AddCirsPar (void)
	Add parameters for CIRS coordinates. More...
void	AddCirsPars (void)
	Add parameters for CIRS coordinates. More...
void	AddCorrFilePars (void)
	Add parameter for the corrections file path. More...
void	AddEclipticPar (void)
	Add parameters for Ecliptic coordinates. More...
void	AddGalacticPar (void)
	Add parameters for Galactic coordinates. More...
void	AddGalacticPars (void)
	Add parameters for Galactic coordinates. More...
void	AddIcrsPar (void)
	Add parameters for ICRS coordinates. More...
void	AddIcrsPars (void)
	Add parameters for ICRS coordinates. More...
void	AddJDPar (void)
	Add parameter for the Julian date. More...
void	AddObservedPar (void)
	Add parameters for Observed coordinates. More...
void	AddObservedPars (void)
	Add parameters for observed azimuth,zenith coordinates. More...
void	AddObserverPars (void)
	Add parameters defining an observer and their atmospheric properties. More...
	CEExecOptions ()
	Default constructor. More...
	CEExecOptions (const std::string &prog_name)
	Construct from a program name. More...
CEObserver	GenObserver (void)
	Generate an observer object. More...
CEExecOptions &	operator= (const CEExecOptions &other)
	Copy assignment operator. More...
void	SetCorrFiles (void)
	Defines the corrections terms from user supplied options. More...
void	SetProgName (const std::string &prog_name)
	Defines the program name and sets the version information. More...
virtual	~CEExecOptions ()
	Deconstruct. More...

Private Member Functions
void	copy_members (const CEExecOptions &other)
	Copy data members from another object of the same class. More...
void	free_members (void)
	Free explicitly allocated memory. More...
void	init_members (void)
	Initialize data members. More...

Private Attributes
std::string	prog_name_

#include <CEExecOptions.h>

Inheritance diagram for CEExecOptions:

Collaboration diagram for CEExecOptions:

Constructor & Destructor Documentation

CEExecOptions() [1/2]

CEExecOptions::CEExecOptions ( )

inline

Default constructor.

Definition at line 15 of file CEExecOptions.h.

CEExecOptions() [2/2]

CEExecOptions::CEExecOptions ( const std::string &  prog_name )

inline

Construct from a program name.

Parameters

[in]

prog_name

Name of the program

Definition at line 23 of file CEExecOptions.h.

~CEExecOptions()

virtual CEExecOptions::~CEExecOptions ( )

inlinevirtual

Deconstruct.

Definition at line 31 of file CEExecOptions.h.

Member Function Documentation

AddCirsPar()

void CEExecOptions::AddCirsPar ( void  )

inline

Add parameters for CIRS coordinates.

Adds the following parameters:

"cirs" CIRS "RA,Dec" (degrees)

Definition at line 226 of file CEExecOptions.h.

AddCirsPars()

void CEExecOptions::AddCirsPars ( void  )

inline

Add parameters for CIRS coordinates.

Adds the following parameters:

'r' or "ra" Right ascension in CIRS reference frame 'd' or "dec" Declination in CIRS reference frame

Definition at line 91 of file CEExecOptions.h.

AddCorrFilePars()

void CEExecOptions::AddCorrFilePars ( void  )

inline

Add parameter for the corrections file path.

Adds the following parameters:

"corrfilepath"" Input path to directory containing corrections files

Definition at line 207 of file CEExecOptions.h.

AddEclipticPar()

void CEExecOptions::AddEclipticPar ( void  )

inline

Add parameters for Ecliptic coordinates.

Adds the following parameters:

"ecliptic" Ecliptic "longitude,latitude" (degrees)

Definition at line 278 of file CEExecOptions.h.

AddGalacticPar()

void CEExecOptions::AddGalacticPar ( void  )

inline

Add parameters for Galactic coordinates.

Adds the following parameters:

"galactic" Galactic "longitude,latitude" (degrees)

Definition at line 260 of file CEExecOptions.h.

AddGalacticPars()

void CEExecOptions::AddGalacticPars ( void  )

inline

Add parameters for Galactic coordinates.

Adds the following parameters:

'l' or "glon" Galactic longitude (degrees) 'b' or "glat" Galactic latitude (degrees)

Definition at line 125 of file CEExecOptions.h.

AddIcrsPar()

void CEExecOptions::AddIcrsPar ( void  )

inline

Add parameters for ICRS coordinates.

Adds the following parameters:

"icrs" ICRS "RA,Dec" (degrees)

Definition at line 243 of file CEExecOptions.h.

AddIcrsPars()

void CEExecOptions::AddIcrsPars ( void  )

inline

Add parameters for ICRS coordinates.

Adds the following parameters:

'R' or "ra" Right ascension in ICRS reference frame 'D' or "dec" Declination in ICRS reference frame

Definition at line 108 of file CEExecOptions.h.

AddJDPar()

void CEExecOptions::AddJDPar ( void  )

inline

Add parameter for the Julian date.

Adds the following parameters:

'j' or "juliandate" Input Julian date (defaults to current JD)

Definition at line 193 of file CEExecOptions.h.

AddObservedPar()

void CEExecOptions::AddObservedPar ( void  )

inline

Add parameters for Observed coordinates.

Adds the following parameters:

"observed" Observed "altitude,zenith" (degrees)

Definition at line 295 of file CEExecOptions.h.

AddObservedPars()

void CEExecOptions::AddObservedPars ( void  )

inline

Add parameters for observed azimuth,zenith coordinates.

Adds the following parameters:

'a' or "azimuth" Azimuth angle (degrees, north=0, east=90) 'z' or "zenith" Zenith angle (degrees)

Definition at line 142 of file CEExecOptions.h.

AddObserverPars()

void CEExecOptions::AddObserverPars ( void  )

inline

Add parameters defining an observer and their atmospheric properties.

Adds the following parameters:

'x' or "longitude" Observer geographic longitude (degrees east positive) 'y' or "latitude" Observer geographic latitude (degrees) "elevation" Observer elevation (meters) "pressure" Observer's atmospheric pressure (hPa) "humidity" Observer's relative humidity (0-1) "temperature" Observer's atmospheric temperature (Celsius) "wavelength" Observing wavelength (micrometers)

Definition at line 169 of file CEExecOptions.h.

copy_members()

void CEExecOptions::copy_members ( const CEExecOptions &  other )

inlineprivate

Copy data members from another object of the same class.

Parameters

[in]

other

CEExecOptions object to copy from

Definition at line 357 of file CEExecOptions.h.

free_members()

void CEExecOptions::free_members ( void  )

inlineprivate

Free explicitly allocated memory.

Definition at line 375 of file CEExecOptions.h.

GenObserver()

CEObserver CEExecOptions::GenObserver ( void  )

inline

Generate an observer object.

Definition at line 307 of file CEExecOptions.h.

init_members()

void CEExecOptions::init_members ( void  )

inlineprivate

Initialize data members.

Definition at line 366 of file CEExecOptions.h.

operator=()

CEExecOptions& CEExecOptions::operator= ( const CEExecOptions &  other )

inline

Copy assignment operator.

Parameters

[in]

other

CEExecOptions object to be copied

Definition at line 37 of file CEExecOptions.h.

SetCorrFiles()

void CEExecOptions::SetCorrFiles ( void  )

inline

Defines the corrections terms from user supplied options.

Definition at line 324 of file CEExecOptions.h.

SetProgName()

void CEExecOptions::SetProgName ( const std::string &  prog_name )

inline

Defines the program name and sets the version information.

Parameters

[in]

prog_name

Program name

Definition at line 345 of file CEExecOptions.h.

Member Data Documentation

prog_name_

std::string CEExecOptions::prog_name_

private

Definition at line 76 of file CEExecOptions.h.

---

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

• cppephem/support/CEExecOptions.h