wsf::coverage::IntervalConstraint Class Reference

#include <WsfCoverageIntervalConstraint.hpp>

Public Member Functions
	IntervalConstraint ()=default
	IntervalConstraint (const IntervalConstraint &aOther)=default
	~IntervalConstraint ()=default
IntervalConstraint *	Clone () const
bool	ProcessInput (UtInput &aInput)
void	Initialize (const Coverage &aCoverage, const std::string &aOutputDir)
	Initialize this object.
void	Finalize (const UtCalendar &aSimStartEpoch) const
bool	FilterInterval (const GridAsset &aGridAsset, const FreeAsset &aFreeAsset, const AccessInterval &aInterval) const
std::string	GetOutputFileName () const

Detailed Description

Provides access interval duration constraints.

This class implements constraints on the duration of access intervals. The owning Coverage object will filter all complete access intervals through this constraint to decide if the interval meets the specified duration limits. The limits can be specified for platforms of a given name or type, or devices of a given name or type. Additionally, instances can be configured to write any filtered intervals out to file.

Constructor & Destructor Documentation

IntervalConstraint() [1/2]

wsf::coverage::IntervalConstraint::IntervalConstraint ( )

default

Referenced by Clone(), and IntervalConstraint().

IntervalConstraint() [2/2]

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

default

References IntervalConstraint().

~IntervalConstraint()

wsf::coverage::IntervalConstraint::~IntervalConstraint ( )

default

Member Function Documentation

Clone()

IntervalConstraint * wsf::coverage::IntervalConstraint::Clone ( ) const

inline

References IntervalConstraint().

FilterInterval()

bool wsf::coverage::IntervalConstraint::FilterInterval	(	const GridAsset &	aGridAsset,
		const FreeAsset &	aFreeAsset,
		const AccessInterval &	aInterval ) const

Determine if the given interval should be filtered.

Determined if the given aInterval involving the given aGridAsset and given aFreeAsset should be ignored in the coverage computation.

Parameters

aGridAsset	- The grid asset involved in the interval in question.
aFreeAsset	- The free asset involved in the interval in question.
aInterval	- The interval in question.

Returns

- true if the interval should be removed from the coverage computation.

Finalize()

void wsf::coverage::IntervalConstraint::Finalize

(

const UtCalendar &

aSimStartEpoch

)

const

Finalize the constraint.

This will write out any filtered intervals if this object was so configured.

GetOutputFileName()

std::string wsf::coverage::IntervalConstraint::GetOutputFileName

(

)

const

Return the filename into which the filtered intervals will be written.

This will return either a default constructed string if this object was not configured to produce an output file with the filtered intervals, or the name of the file into which that data will be written.

Returns

- The name of the file into which the filtered intervals will be written, or an empty string if not configured for output.

Initialize()

void wsf::coverage::IntervalConstraint::Initialize	(	const Coverage &	aCoverage,
		const std::string &	aOutputDir )

Initialize this object.

ProcessInput()

bool wsf::coverage::IntervalConstraint::ProcessInput

(

UtInput &

aInput

)

---

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

• WsfCoverageIntervalConstraint.hpp
• WsfCoverageIntervalConstraint.cpp