HOPS
HOPS class reference
Public Member Functions | Protected Attributes | List of all members
hops::MHO_StationIdentity Class Reference

Class MHO_StationIdentity - a class to store, associate, and compare 1-char, 2-char, and 8-char station code/id/name identifiers. More...

#include <MHO_StationIdentity.hh>

Public Member Functions

 MHO_StationIdentity ()
 
 MHO_StationIdentity (const mho_json &site_vex)
 
 MHO_StationIdentity (const MHO_StationIdentity &copy)
 
 MHO_StationIdentity (const std::string &name, const std::string &code, const std::string &mk4id)
 
virtual ~MHO_StationIdentity ()
 
std::string as_string () const
 
bool from_string (const std::string &station_id_string)
 
std::string GetStationCode () const
 
std::string GetStationMk4Id () const
 
std::string GetStationName () const
 
bool matches (const std::string &station_identifier) const
 
bool operator!= (const MHO_StationIdentity &rhs) const
 
bool operator< (const MHO_StationIdentity &rhs) const
 
MHO_StationIdentityoperator= (const MHO_StationIdentity &rhs)
 
bool operator== (const MHO_StationIdentity &rhs) const
 
void SetAll (const std::string &name, const std::string &code, const std::string &mk4id)
 
void SetStationCode (const std::string &code)
 
void SetStationMk4ID (const std::string &id)
 
void SetStationName (const std::string &name)
 

Protected Attributes

std::string fStationCode
 
std::string fStationMk4ID
 
std::string fStationName
 

Detailed Description

Class MHO_StationIdentity - a class to store, associate, and compare 1-char, 2-char, and 8-char station code/id/name identifiers.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Nov 13 01:34:27 PM EST 2025

Constructor & Destructor Documentation

◆ MHO_StationIdentity() [1/4]

hops::MHO_StationIdentity::MHO_StationIdentity ( )
inline

◆ MHO_StationIdentity() [2/4]

hops::MHO_StationIdentity::MHO_StationIdentity ( const std::string &  name,
const std::string &  code,
const std::string &  mk4id 
)
inline

◆ MHO_StationIdentity() [3/4]

hops::MHO_StationIdentity::MHO_StationIdentity ( const mho_json site_vex)
inline

◆ ~MHO_StationIdentity()

virtual hops::MHO_StationIdentity::~MHO_StationIdentity ( )
inlinevirtual

◆ MHO_StationIdentity() [4/4]

hops::MHO_StationIdentity::MHO_StationIdentity ( const MHO_StationIdentity copy)
inline

Member Function Documentation

◆ as_string()

std::string hops::MHO_StationIdentity::as_string ( ) const
inline
  • Convert the station identifier to a formatted string
    Returns
    A std::string containing station id info, delimited by commas

◆ from_string()

bool hops::MHO_StationIdentity::from_string ( const std::string &  station_id_string)
inline
  • Read a formatted string to fill this object
    Returns
    success on updating the station identity object using string info

◆ GetStationCode()

std::string hops::MHO_StationIdentity::GetStationCode ( ) const
inline

◆ GetStationMk4Id()

std::string hops::MHO_StationIdentity::GetStationMk4Id ( ) const
inline

◆ GetStationName()

std::string hops::MHO_StationIdentity::GetStationName ( ) const
inline

◆ matches()

bool hops::MHO_StationIdentity::matches ( const std::string &  station_identifier) const
inline
  • Check if this station identity matches the given 1-char/2-char code or multi-char name
    Returns
    A boolean if successful match

◆ operator!=()

bool hops::MHO_StationIdentity::operator!= ( const MHO_StationIdentity rhs) const
inline

◆ operator<()

bool hops::MHO_StationIdentity::operator< ( const MHO_StationIdentity rhs) const
inline

◆ operator=()

MHO_StationIdentity& hops::MHO_StationIdentity::operator= ( const MHO_StationIdentity rhs)
inline

◆ operator==()

bool hops::MHO_StationIdentity::operator== ( const MHO_StationIdentity rhs) const
inline

◆ SetAll()

void hops::MHO_StationIdentity::SetAll ( const std::string &  name,
const std::string &  code,
const std::string &  mk4id 
)
inline

◆ SetStationCode()

void hops::MHO_StationIdentity::SetStationCode ( const std::string &  code)
inline

◆ SetStationMk4ID()

void hops::MHO_StationIdentity::SetStationMk4ID ( const std::string &  id)
inline

◆ SetStationName()

void hops::MHO_StationIdentity::SetStationName ( const std::string &  name)
inline

Member Data Documentation

◆ fStationCode

std::string hops::MHO_StationIdentity::fStationCode
protected

◆ fStationMk4ID

std::string hops::MHO_StationIdentity::fStationMk4ID
protected

◆ fStationName

std::string hops::MHO_StationIdentity::fStationName
protected

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