wsf::coverage::RawDataOutput Class Reference

This object will store and output to file the raw access interval data for a coverage computation. More...

#include <WsfCoverageRawDataOutput.hpp>

Public Member Functions
	RawDataOutput (const std::string &aFileName)
	RawDataOutput (const RawDataOutput &aOther)=default
RawDataOutput *	Clone ()
void	AddInterval (const GridAsset &aGridAsset, const FreeAsset &aFreeAsset, const AccessInterval &aInterval)
std::size_t	GetNumIntervals () const
	Return the number of stored intervals.
void	Write (const UtCalendar &aSimStartEpoch) const
void	Write (TextOutputWriter &aWriter, const UtCalendar &aSimStartEpoch) const
const std::string &	GetFileName () const
	Return the name of the file into which the data will be written.
const std::string &	GetOutputDir () const
	Return the directory into which the data file will be written.
void	SetFileName (const std::string &aFileName)
	Set the name of the file into which the data will be written.
void	SetOutputDir (const std::string &aOutputDir)
	Set the directory into which the data file will be written.

Detailed Description

This object will store and output to file the raw access interval data for a coverage computation.

Constructor & Destructor Documentation

RawDataOutput() [1/2]

wsf::coverage::RawDataOutput::RawDataOutput ( const std::string & aFileName )

inlineexplicit

Referenced by Clone(), and RawDataOutput().

RawDataOutput() [2/2]

wsf::coverage::RawDataOutput::RawDataOutput ( const RawDataOutput & aOther )

default

References RawDataOutput().

Member Function Documentation

AddInterval()

void wsf::coverage::RawDataOutput::AddInterval	(	const GridAsset &	aGridAsset,
		const FreeAsset &	aFreeAsset,
		const AccessInterval &	aInterval )

Add an interval to the stored data.

This will add the given aInterval between for an interaction between the given aGridAsset and the given aFreeAsset.

Parameters

aGridAsset	- The grid asset participating in the interaction.
aFreeAsset	- The free asset participating in the interaction.
aInterval	- The interaction interval.

Clone()

RawDataOutput * wsf::coverage::RawDataOutput::Clone ( )

inline

References RawDataOutput().

GetFileName()

const std::string & wsf::coverage::RawDataOutput::GetFileName ( ) const

inline

Return the name of the file into which the data will be written.

GetNumIntervals()

std::size_t wsf::coverage::RawDataOutput::GetNumIntervals ( ) const

inline

Return the number of stored intervals.

GetOutputDir()

const std::string & wsf::coverage::RawDataOutput::GetOutputDir ( ) const

inline

Return the directory into which the data file will be written.

SetFileName()

void wsf::coverage::RawDataOutput::SetFileName ( const std::string & aFileName )

inline

Set the name of the file into which the data will be written.

SetOutputDir()

void wsf::coverage::RawDataOutput::SetOutputDir ( const std::string & aOutputDir )

inline

Set the directory into which the data file will be written.

Write() [1/2]

void wsf::coverage::RawDataOutput::Write

(

const UtCalendar &

aSimStartEpoch

)

const

Write the data to file.

Parameters

aSimStartEpoch

- The date and time of the start of the simulation.

References Write().

Referenced by Write().

Write() [2/2]

void wsf::coverage::RawDataOutput::Write	(	TextOutputWriter &	aWriter,
		const UtCalendar &	aSimStartEpoch ) const

Write the data using the given output writer.

This will put the data out using the given aWriter. This is primarily useful for unit testing.

Parameters

aWriter	- The text output writer to use to output the data in this object.
aSimStartEpoch	- The date and time of the start of the simulation.

References wsf::coverage::TextOutputWriter::CloseStream(), wsf::coverage::TextOutputWriter::CreateContainingFolder(), wsf::coverage::TextOutputWriter::OpenFile(), wsf::coverage::TextOutputWriter::SetFixedFormat(), wsf::coverage::TextOutputWriter::SetRightJustified(), wsf::coverage::TextOutputWriter::SetStreamFormat(), wsf::coverage::TextOutputWriter::SetStreamJustify(), and wsf::coverage::TextOutputWriter::SetWidth().

---

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

• WsfCoverageRawDataOutput.hpp
• WsfCoverageRawDataOutput.cpp