carma::services::Pad Class Reference

This class specifies an antenna pad or station with coordinates, name, and array configuration membership. More...

#include <carma/services/Pad.h>

Public Member Functions
std::vector< std::string >	getArrayConfigs () const
std::vector < carma::services::Length * >	getEnu () const
carma::services::Location	getLocation () const
std::string	getName () const
unsigned short	getPadNo () const
carma::services::Location	getReference () const
bool	isInArrayConfig (const std::string &array)
	Pad (const std::string &observatory=CARMA_OBSERVATORY, const std::string &pad=REFERENCE)
	Constructor using observatory name and pad designation from the catalog that should live in CARMA/conf/catalogs/Observatory.cat. More...
	Pad (const std::string &observatory, const std::string &pad, const carma::services::Location &padLocation, const carma::services::Location &arrayReference, const std::string &arrayConfigs)
	Constructor using observatory name and pad designation from the catalog that should live in CARMA/conf/catalogs/Observatory.cat. More...
std::string	toString () const

Detailed Description

This class specifies an antenna pad or station with coordinates, name, and array configuration membership.

Definition at line 25 of file Pad.h.

Constructor & Destructor Documentation

carma::services::Pad::Pad	(	const std::string &	observatory = CARMA_OBSERVATORY,
		const std::string &	pad = REFERENCE
	)

Constructor using observatory name and pad designation from the catalog that should live in CARMA/conf/catalogs/Observatory.cat.

Parameters

observatory	Case-insensitive name of the observatory. Examples are "CARMA", "ovro", "wsrt" etc.
pad	Name of the pad/station. Examples are "pad#29", "Area-51". The pad names are case-sensitive.

carma::services::Pad::Pad	(	const std::string &	observatory,
		const std::string &	pad,
		const carma::services::Location &	padLocation,
		const carma::services::Location &	arrayReference,
		const std::string &	arrayConfigs
	)

Constructor using observatory name and pad designation from the catalog that should live in CARMA/conf/catalogs/Observatory.cat.

Parameters

observatory	Name of the observatory
observatory	Case-insensitive name of the observatory. Examples are "CARMA", "ovro", "wsrt" etc.
pad	Name of the pad/station. Examples are "pad#29", "Area-51". The pad names are case-sensitive.
padLocation	Location object indicating longitude, latitude,and altitude of this pad.
arrayReference	Location object indicating longitude, latitude,and altitude of the array reference position for this pad.
arrayConfigs	string representing the array configuration(s) in which this pad is a member. Individual configurations must be comma-separated, e.g. "A,B,BnC", and are case-sensitive.

Member Function Documentation

std::vector<std::string> carma::services::Pad::getArrayConfigs

(

)

const

Returns

a representation of the array configurations in which this pad is a member. The pad<->array configuration information is located in Observatory.cat.

Definition at line 114 of file Pad.h.

std::vector<carma::services::Length*> carma::services::Pad::getEnu

(

)

const

Returns

vector of carma::services::Length containing East, North, Up (in that order) offsets of this pad, with respect to its array reference position.

Definition at line 86 of file Pad.h.

carma::services::Location carma::services::Pad::getLocation

(

void

)

const

Returns

The fixed Location of this pad.

Definition at line 68 of file Pad.h.

std::string carma::services::Pad::getName

(

)

const

Returns

the name/designation of this pad

Definition at line 94 of file Pad.h.

unsigned short carma::services::Pad::getPadNo

(

)

const

Returns

The pad number of this Pad. The pad name is searched for the substring "#", and everything after the # sign is assumed to be the pad number. If substring "#" does not exist or the string-to-number conversion fails, an NotFoundException is thrown.

carma::services::Location carma::services::Pad::getReference

(

)

const

Returns

The array reference position for this pad.

Definition at line 76 of file Pad.h.

bool carma::services::Pad::isInArrayConfig

(

const std::string &

array

)

Returns

true if this pad is in the specified array configuration, false, otherwise. This comparison is case-sensitive.

std::string carma::services::Pad::toString

(

)

const

Returns

a string description of this pad

---

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

• carma/services/Pad.h