CARMA C++
carma::services::Neighbor Class Reference

Data on nearest neighbor to a source. More...

#include <carma/services/Neighbor.h>

Public Member Functions

float getAzimuth () const
 
float getBrightness () const
 
float getDistance () const
 
float getElevation () const
 
double getMJD () const
 
const ::std::string getName () const
 
const ::std::string getReference () const
 
bool isOptical () const
 
 Neighbor ()
 Default constructor. More...
 
bool operator< (const Neighbor &neighbor) const
 Compares distance member values. More...
 
bool operator== (const Neighbor &neighbor)
 Compare two Neighbors. More...
 
void setAzimuth (const float azimuth)
 
void setBrightness (const float brightness)
 
void setDistance (const float distance)
 
void setElevation (const float elevation)
 
void setMJD (const double mjd)
 
void setName (::std::string name)
 
void setOptical (const bool optical)
 
void setReference (::std::string reference)
 
virtual ~Neighbor ()
 Destructor. More...
 

Detailed Description

Data on nearest neighbor to a source.

Mirrors IDL NearestInfo struct in carma::control

See Also
SubarrayControl::getNearest().

Definition at line 24 of file Neighbor.h.

Constructor & Destructor Documentation

carma::services::Neighbor::Neighbor ( )

Default constructor.

virtual carma::services::Neighbor::~Neighbor ( )
virtual

Destructor.

Member Function Documentation

bool carma::services::Neighbor::operator< ( const Neighbor neighbor) const

Compares distance member values.

Use for sorting the NeighborSet.

Returns
true if LHS object's distance is less than RHS object's distance, false otherwise.
bool carma::services::Neighbor::operator== ( const Neighbor neighbor)

Compare two Neighbors.

Returns
true all LHS object's member variables are the same as the RHS object's, false otherwise.

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