VieSched++
VieVS VLBI Scheduling Software
VieVS::Baseline Class Reference

representation of a VLBI baseline More...

#include <Baseline.h>

Inheritance diagram for VieVS::Baseline:
Collaboration diagram for VieVS::Baseline:

Classes

struct  Event
 event which changes parameters More...
 
class  Parameters
 baseline parameters More...
 
struct  Statistics
 baseline statistics More...
 

Public Member Functions

 Baseline (std::string name, std::string alternativeName, unsigned long staid1, unsigned long staid2)
 constructor More...
 
bool hasStationIds (unsigned long staid1, unsigned long staid2) const noexcept
 checks if this baseline is between the two stations More...
 
bool hasStationIds (const std::pair< unsigned long, unsigned long > &staids) const noexcept
 checks if this baseline is between the two stations More...
 
void setEVENTS (std::vector< Event > &EVENTS) noexcept
 sets all upcoming events More...
 
ParametersrefParaForMultiScheduling ()
 reference parameters to add multi-scheduling setup More...
 
unsigned long getStaid1 () const noexcept
 getter method for first station id More...
 
unsigned long getStaid2 () const noexcept
 getter method for second station id More...
 
std::pair< unsigned long, unsigned long > getStaids () const noexcept
 getter method for station ids More...
 
const ParametersgetParameters () const
 getter for current parameters More...
 
ParametersrefParameters ()
 reference of current parameters More...
 
bool checkForNewEvent (unsigned int time, bool &hardBreak) noexcept
 checks for new events at certain time More...
 
void update (bool influence) noexcept
 update new observation More...
 
void setNextEvent (unsigned int idx) noexcept
 set next event index More...
 
void setStatistics (const Statistics &stat)
 set baseline statistics More...
 
const StatisticsgetStatistics () const
 getter for baseline statistics More...
 
unsigned long getNObs () const
 get number of observations More...
 
- Public Member Functions inherited from VieVS::VieVS_NamedObject
 VieVS_NamedObject (std::string name, unsigned long id)
 constructor More...
 
 VieVS_NamedObject (std::string name, std::string alternativeName, unsigned long id)
 constructor More...
 
const std::string & getName () const
 get object name More...
 
const std::string & getAlternativeName () const
 get object alternative name More...
 
bool hasAlternativeName () const
 check if object has alternative name More...
 
bool hasName (const std::string &name) const
 check if object has name More...
 
void changeName (const std::string &newName)
 change name of object More...
 
- Public Member Functions inherited from VieVS::VieVS_Object
 VieVS_Object (unsigned long id)
 constructor More...
 
const unsigned long getId () const
 get object id More...
 
bool hasValidId () const
 check if id is valid More...
 
bool hasId (unsigned long id) const
 check if object has specific id More...
 
void setId (unsigned long id)
 set object id More...
 
std::string printId () const
 object id string More...
 

Private Attributes

unsigned long staid1_
 id of first antenna More...
 
unsigned long staid2_
 id of second antenna More...
 
std::vector< Eventevents_
 list of all events More...
 
Statistics statistics_
 baseline statistics More...
 
Parameters parameters_
 station parameters More...
 
unsigned int nextEvent_ { 0 }
 index of next event More...
 
int nObs_ { 0 }
 number of observations More...
 
int nTotalObs_ { 0 }
 number of total observations More...
 

Static Private Attributes

static unsigned long nextId = 0
 next id for this object type More...
 

Detailed Description

representation of a VLBI baseline

Author
Matthias Schartner
Date
23.06.2018

Constructor & Destructor Documentation

Baseline::Baseline ( std::string  name,
std::string  alternativeName,
unsigned long  staid1,
unsigned long  staid2 
)

constructor

Author
Matthias Schartner
Parameters
namebaseline name (station 1 two letter code - station 2 two letter code)
alternativeNamebaseline alternative name (station 2 two letter code - station 1 two letter code)
staid1station 1 id
staid2station 2 id

Member Function Documentation

bool Baseline::checkForNewEvent ( unsigned int  time,
bool &  hardBreak 
)
noexcept

checks for new events at certain time

Author
Matthias Schartner
Parameters
timetarget time
hardBreakreturn which tells you if a hard break occured
Returns
true if a new event occured, otherwise false

Here is the caller graph for this function:

unsigned long VieVS::Baseline::getNObs ( ) const
inline

get number of observations

Author
Matthias Schartner
Returns
number of observations
const Parameters& VieVS::Baseline::getParameters ( ) const
inline

getter for current parameters

Author
Matthias Schartner
Returns
current parameters

Here is the caller graph for this function:

unsigned long VieVS::Baseline::getStaid1 ( ) const
inlinenoexcept

getter method for first station id

Author
Matthias Schartner
Returns
first station id

Here is the caller graph for this function:

unsigned long VieVS::Baseline::getStaid2 ( ) const
inlinenoexcept

getter method for second station id

Author
Matthias Schartner
Returns
second station id

Here is the caller graph for this function:

std::pair<unsigned long, unsigned long> VieVS::Baseline::getStaids ( ) const
inlinenoexcept

getter method for station ids

Author
Matthias Schartner
Returns
pair of station ids
const Statistics& VieVS::Baseline::getStatistics ( ) const
inline

getter for baseline statistics

Author
Matthias Schartner
Returns
baseline statistics

Here is the caller graph for this function:

bool Baseline::hasStationIds ( unsigned long  staid1,
unsigned long  staid2 
) const
noexcept

checks if this baseline is between the two stations

Author
Matthias Schartner
Parameters
staid1station id 1
staid2station id 2
Returns
true is baseline is between those stations, otherwise false

Here is the caller graph for this function:

bool Baseline::hasStationIds ( const std::pair< unsigned long, unsigned long > &  staids) const
noexcept

checks if this baseline is between the two stations

Author
Matthias Schartner
Parameters
staidsstation ids
Returns
true is baseline is between those stations, otherwise false

Here is the call graph for this function:

Parameters& VieVS::Baseline::refParaForMultiScheduling ( )
inline

reference parameters to add multi-scheduling setup

Author
Matthias Schartner
Returns
reference to parameters object

Here is the caller graph for this function:

Parameters& VieVS::Baseline::refParameters ( )
inline

reference of current parameters

Author
Matthias Schartner
Returns
current parameters

Here is the call graph for this function:

Here is the caller graph for this function:

void VieVS::Baseline::setEVENTS ( std::vector< Event > &  EVENTS)
inlinenoexcept

sets all upcoming events

Author
Matthias Schartner
Parameters
EVENTSall upcoming events

Here is the caller graph for this function:

void VieVS::Baseline::setNextEvent ( unsigned int  idx)
inlinenoexcept

set next event index

Author
Matthias Schartner
Parameters
idxnew idx
void VieVS::Baseline::setStatistics ( const Statistics stat)
inline

set baseline statistics

Author
Matthias Schartner
Parameters
statbaseline statistics

Here is the caller graph for this function:

void Baseline::update ( bool  influence)
noexcept

update new observation

Author
Matthias Schartner
Parameters
influencetrue is observation should count for further scan selections, otherwise false

Here is the caller graph for this function:

Member Data Documentation

std::vector<Event> VieVS::Baseline::events_
private

list of all events

unsigned int VieVS::Baseline::nextEvent_ { 0 }
private

index of next event

unsigned long Baseline::nextId = 0
staticprivate

next id for this object type

int VieVS::Baseline::nObs_ { 0 }
private

number of observations

int VieVS::Baseline::nTotalObs_ { 0 }
private

number of total observations

Parameters VieVS::Baseline::parameters_
private

station parameters

unsigned long VieVS::Baseline::staid1_
private

id of first antenna

unsigned long VieVS::Baseline::staid2_
private

id of second antenna

Statistics VieVS::Baseline::statistics_
private

baseline statistics


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