create Operation notes output or skdsum output More...

#include <OperationNotes.h>

Inheritance diagram for VieVS::OperationNotes:

Collaboration diagram for VieVS::OperationNotes:

Public Member Functions
	OperationNotes (const std::string &file)
	constructor More...

void	writeOperationNotes (const Network &network, const SourceList &sourceList, const std::vector< Scan > &scans, const std::shared_ptr< const ObservingMode > &obsModes, const boost::property_tree::ptree &xml, int version, boost::optional< MultiScheduling::Parameters > multiSchedulingParameters=boost::none)
	write operation notes file More...

void	writeSkdsum (const Network &network, const SourceList &sourceList, const std::vector< Scan > &scans)
	write simple skdsum file 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 Member Functions
void	displayGeneralStatistics (const std::vector< Scan > &scans)
	general statistics of the schedule More...

void	displayBaselineStatistics (const Network &network)
	baseline dependent statistics of the schedule More...

void	displayStationStatistics (const Network &network)
	displays some station dependent statistics of the schedule More...

void	displaySourceStatistics (const SourceList &sourceList)
	displays some source dependent statistics of the schedule More...

void	displayNstaStatistics (const Network &network, const std::vector< Scan > &scans)
	number of stations per scan statistics More...

void	displayScanDurationStatistics (const Network &network, const std::vector< Scan > &scans)
	source dependent statistics of the schedule More...

void	displayTimeStatistics (const Network &network, const std::shared_ptr< const ObservingMode > &obsModes)
	time spend per station More...

void	displayAstronomicalParameters ()
	list astronomical parameters More...

void	displaySNRSummary (const Network &network, const SourceList &sourceList, const std::vector< Scan > &scans, const std::shared_ptr< const ObservingMode > &obsModes)
	display summary of theoretical SNR values More...

void	firstLastObservations_skdStyle (const std::string &expName, const Network &network, const SourceList &sourceList, const std::vector< Scan > &scans)
	list first and last observations in skd style More...

void	calibrators_skdStyle (const std::string &expName, const Network &network, const SourceList &sourceList, const std::vector< Scan > &scans)
	list calibrator scans in skd style More...

void	listKeys (const Network &network)
	list key=stationName More...

void	displaySkyCoverageScore (const Network &network)
	list sky coverage scores More...

void	contactInformations (std::vector< std::string > &functions, std::vector< std::string > &names, std::vector< std::string > &emails, std::vector< std::string > &phoneNumbers, std::vector< std::string > &affiliations, std::map< int, int > &nameId2affiliationId, const boost::property_tree::ptree &xml)
	get contact information from xml file More...

Private Attributes
std::ofstream	of
	output stream object More...

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

Detailed Description

create Operation notes output or skdsum output

Author: Matthias Schartner

Date: 22.08.2017

Constructor & Destructor Documentation

OperationNotes::OperationNotes ( const std::string & file )

explicit

constructor

Author: Matthias Schartner

Parameters

file file name

Member Function Documentation

void OperationNotes::calibrators_skdStyle	(	const std::string &	expName,
		const Network &	network,
		const SourceList &	sourceList,
		const std::vector< Scan > &	scans
	)

private

list calibrator scans in skd style

Author: Matthias Schartner

lists all calibrator scans

Parameters

expName	experiment name
network	station network
sourceList	list of all sources
scans	list of all scans

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::contactInformations	(	std::vector< std::string > &	functions,
		std::vector< std::string > &	names,
		std::vector< std::string > &	emails,
		std::vector< std::string > &	phoneNumbers,
		std::vector< std::string > &	affiliations,
		std::map< int, int > &	nameId2affiliationId,
		const boost::property_tree::ptree &	xml
	)

private

get contact information from xml file

Author: Matthias Schartner

Parameters

functions	(output) list of all functions found in xml file
names	(output) list of all names found in xml file
emails	(output) list of all emails found in xml file
phoneNumbers	(output) list of all phone numbers found in xml file
affiliations	(output) list of all affiliations found in xml file
nameId2affiliationId	(output) map linking name and affiliation
xml	paramters.xml file

Here is the caller graph for this function:

void OperationNotes::displayAstronomicalParameters ( )

private

list astronomical parameters

Author: Matthias Schartner

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displayBaselineStatistics ( const Network & network )

private

baseline dependent statistics of the schedule

Author: Matthias Schartner

Parameters

network station network

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displayGeneralStatistics ( const std::vector< Scan > & scans )

private

general statistics of the schedule

Author: Matthias Schartner

Parameters

scans list of all scans

Here is the caller graph for this function:

void OperationNotes::displayNstaStatistics	(	const Network &	network,
		const std::vector< Scan > &	scans
	)

private

number of stations per scan statistics

Author: Matthias Schartner

Parameters

network	station network
scans	list of all scans

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displayScanDurationStatistics	(	const Network &	network,
		const std::vector< Scan > &	scans
	)

private

source dependent statistics of the schedule

Author: Matthias Schartner

Parameters

network	station network
scans	list of all scans

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displaySkyCoverageScore ( const Network & network )

private

list sky coverage scores

Author: Matthias Schartner

Parameters

network station network

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displaySNRSummary	(	const Network &	network,
		const SourceList &	sourceList,
		const std::vector< Scan > &	scans,
		const std::shared_ptr< const ObservingMode > &	obsModes
	)

private

display summary of theoretical SNR values

Author: Matthias Schartner

Parameters

network	station network
sourceList	list of all sources
scans	list of all scans
obsModes	observing mode

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displaySourceStatistics ( const SourceList & sourceList )

private

displays some source dependent statistics of the schedule

Author: Matthias Schartner

Parameters

sourceList list of all sources

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displayStationStatistics ( const Network & network )

private

displays some station dependent statistics of the schedule

Author: Matthias Schartner

Parameters

network station network

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::displayTimeStatistics	(	const Network &	network,
		const std::shared_ptr< const ObservingMode > &	obsModes
	)

private

time spend per station

Author: Matthias Schartner

Parameters

network	station network
obsModes	observing mode

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::firstLastObservations_skdStyle	(	const std::string &	expName,
		const Network &	network,
		const SourceList &	sourceList,
		const std::vector< Scan > &	scans
	)

private

list first and last observations in skd style

Author: Matthias Schartner

lists as many scans until all stations are listed (maximum of 5)

Parameters

expName	experiment name
network	station network
sourceList	list of all sources
scans	list of all scans

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::listKeys ( const Network & network )

private

list key=stationName

Author: Matthias Schartner

Parameters

network station network

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::writeOperationNotes	(	const Network &	network,
		const SourceList &	sourceList,
		const std::vector< Scan > &	scans,
		const std::shared_ptr< const ObservingMode > &	obsModes,
		const boost::property_tree::ptree &	xml,
		int	version,
		boost::optional< MultiScheduling::Parameters >	multiSchedulingParameters = `boost::none`
	)

write operation notes file

Author: Matthias Schartner

Parameters

network	station network
sourceList	list of all sources
scans	list of all scans
obsModes	observing mode
xml	paramters.xml file
version	version number
multiSchedulingParameters	multi scheduling parameters

Here is the call graph for this function:

Here is the caller graph for this function:

void OperationNotes::writeSkdsum	(	const Network &	network,
		const SourceList &	sourceList,
		const std::vector< Scan > &	scans
	)

write simple skdsum file

Author: Matthias Schartner

Parameters

network	station network
sourceList	list of all sources
scans	list of all scans

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

unsigned long OperationNotes::nextId = 0

staticprivate

next id for this object type

std::ofstream VieVS::OperationNotes::of

private

output stream object

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

/home/travis/build/TUW-VieVS/VieSchedpp/Output/OperationNotes.h
/home/travis/build/TUW-VieVS/VieSchedpp/Output/OperationNotes.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation