Class MHO_FringeData. More...

#include <MHO_FringeData.hh>

Public Member Functions
	MHO_FringeData ()

virtual	~MHO_FringeData ()

MHO_ContainerStore *	GetContainerStore ()
	Getter for container store. More...

mho_json &	GetControlFormat ()
	access to the control format and parsed control statements (as json object) More...

mho_json &	GetControlStatements ()
	Getter for parsed control statements. More...

MHO_ParameterStore *	GetParameterStore ()
	Getter for parameter store. More...

mho_json &	GetPlotData ()
	Getter for plot data. More...

MHO_ScanDataStore *	GetScanDataStore ()
	Getter for scan data store. More...

mho_json	GetVex () const
	Getter for vex data (as json object) More...

int	WriteOutput ()
	Writes output data to disk with a temporary unique name and renames it afterwards. More...

Protected Member Functions
std::string	ConstructFrngFileName (const std::string directory, const std::string &baseline, const std::string &ref_station, const std::string &rem_station, const std::string &frequency_group, const std::string &polprod, const std::string &root_code, int seq_no)
	Constructs a fringe file name string from given parameters. More...

std::string	ConstructTempFileName (const std::string directory, const std::string &baseline, const std::string &ref_station, const std::string &rem_station, const std::string &frequency_group, const std::string &polprod, const std::string &root_code, const std::string &temp_id)
	Constructs a temporary file name using provided parameters and concatenation. More...

int	WriteDataObjects (std::string filename)
	Writes data objects to a file with given filename. More...

Protected Attributes
MHO_ContainerStore	fContainerStore

mho_json	fControlFormat

mho_json	fControlStatements

MHO_ParameterStore	fParameterStore

mho_json	fPlotData

MHO_ScanDataStore	fScanStore

Detailed Description

Class MHO_FringeData.

simple class to contain fringe data objects

Author

Date: Sun Feb 4 20:25:51 2024 -0500

Constructor & Destructor Documentation

◆ MHO_FringeData()

hops::MHO_FringeData::MHO_FringeData ( )

inline

◆ ~MHO_FringeData()

virtual hops::MHO_FringeData::~MHO_FringeData ( )

inlinevirtual

Member Function Documentation

◆ ConstructFrngFileName()

std::string hops::MHO_FringeData::ConstructFrngFileName	(	const std::string	directory,
		const std::string &	baseline,
		const std::string &	ref_station,
		const std::string &	rem_station,
		const std::string &	frequency_group,
		const std::string &	polprod,
		const std::string &	root_code,
		int	seq_no
	)

protected

Constructs a fringe file name string from given parameters.

Parameters

directory	The directory path where the fringe file will be located.
baseline	Baseline identifier for the fringe file.
ref_station	Reference station identifier.
rem_station	Remote station identifier.
frequency_group	Frequency group identifier.
polprod	Polarization product identifier.
root_code	Root code identifier.
seq_no	Sequence number for the fringe file.

Returns: A string representing the constructed fringe file name.

◆ ConstructTempFileName()

std::string hops::MHO_FringeData::ConstructTempFileName	(	const std::string	directory,
		const std::string &	baseline,
		const std::string &	ref_station,
		const std::string &	rem_station,
		const std::string &	frequency_group,
		const std::string &	polprod,
		const std::string &	root_code,
		const std::string &	temp_id
	)

protected

Constructs a temporary file name using provided parameters and concatenation.

Parameters

directory	The directory where the file will be located.
baseline	Baseline identifier for the file.
ref_station	Reference station identifier.
rem_station	Remote station identifier.
frequency_group	Frequency group identifier.
polprod	Polarization-production identifier.
root_code	Root code identifier.
temp_id	Temporary ID for the file.

Returns: The constructed temporary file name as a string.

◆ GetContainerStore()

MHO_ContainerStore* hops::MHO_FringeData::GetContainerStore ( )

inline

Getter for container store.

Returns: MHO_ContainerStore& - Reference to the container store.

◆ GetControlFormat()

mho_json& hops::MHO_FringeData::GetControlFormat ( )

inline

access to the control format and parsed control statements (as json object)

Returns: Reference to mho_json object representing control format

◆ GetControlStatements()

mho_json& hops::MHO_FringeData::GetControlStatements ( )

inline

Getter for parsed control statements.

Returns: Reference to mho_json object containing control statements.

◆ GetParameterStore()

MHO_ParameterStore* hops::MHO_FringeData::GetParameterStore ( )

inline

Getter for parameter store.

Returns: Pointer to MHO_ParameterStore

◆ GetPlotData()

mho_json& hops::MHO_FringeData::GetPlotData ( )

inline

Getter for plot data.

Returns: Reference to mho_json object containing plot data

◆ GetScanDataStore()

MHO_ScanDataStore* hops::MHO_FringeData::GetScanDataStore ( )

inline

Getter for scan data store.

Returns: Pointer to MHO_ScanDataStore

◆ GetVex()

mho_json hops::MHO_FringeData::GetVex ( ) const

inline

Getter for vex data (as json object)

Returns: The root file data as an mho_json object.

◆ WriteDataObjects()

int hops::MHO_FringeData::WriteDataObjects ( std::string filename )

protected

Writes data objects to a file with given filename.

Parameters

filename Filename to write data objects.

Returns: 0 on success, error code otherwise.

◆ WriteOutput()

int hops::MHO_FringeData::WriteOutput ( )

Writes output data to disk with a temporary unique name and renames it afterwards.

Returns: Returns an integer value indicating success or failure.

Member Data Documentation

◆ fContainerStore

MHO_ContainerStore hops::MHO_FringeData::fContainerStore

protected

◆ fControlFormat

mho_json hops::MHO_FringeData::fControlFormat

protected

◆ fControlStatements

mho_json hops::MHO_FringeData::fControlStatements

protected

◆ fParameterStore

MHO_ParameterStore hops::MHO_FringeData::fParameterStore

protected

◆ fPlotData

mho_json hops::MHO_FringeData::fPlotData

protected

◆ fScanStore

MHO_ScanDataStore hops::MHO_FringeData::fScanStore

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MHO_FringeData()

◆ ~MHO_FringeData()

Member Function Documentation

◆ ConstructFrngFileName()

◆ ConstructTempFileName()

◆ GetContainerStore()

◆ GetControlFormat()

◆ GetControlStatements()

◆ GetParameterStore()

◆ GetPlotData()

◆ GetScanDataStore()

◆ GetVex()

◆ WriteDataObjects()

◆ WriteOutput()

Member Data Documentation

◆ fContainerStore

◆ fControlFormat

◆ fControlStatements

◆ fParameterStore

◆ fPlotData

◆ fScanStore