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

Star holds the name and magnitude of a star. More...

#include <carma/services/Star.h>

Inherits carma::services::CatalogEntry.

Public Member Functions

double getMagnitude () const
 
void setMagnitude (double magnitude)
 Set the magnitude of this star. More...
 
 Star ()
 Default constructor. More...
 
virtual ~Star ()
 Destructor. More...
 
- Public Member Functions inherited from carma::services::CatalogEntry
 CatalogEntry ()
 Constructor. More...
 
virtual std::string getName () const
 
virtual void setName (const std::string &name)
 All catalog entries must be named. More...
 
virtual ~CatalogEntry ()
 Destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from carma::services::CatalogEntry
std::string name_
 

Detailed Description

Star holds the name and magnitude of a star.

Used by OpticalCatalog.

Definition at line 21 of file Star.h.

Constructor & Destructor Documentation

carma::services::Star::Star ( )

Default constructor.

virtual carma::services::Star::~Star ( )
virtual

Destructor.

Member Function Documentation

double carma::services::Star::getMagnitude ( ) const
Returns
the (visual) magnitude of this star

Definition at line 33 of file Star.h.

void carma::services::Star::setMagnitude ( double  magnitude)

Set the magnitude of this star.

Parameters
magnitudethe (visual) magnitude of this star

Definition at line 41 of file Star.h.


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