WSF
engage::SiteConfig Class Reference

#include <SiteConfig.hpp>

Classes

class  Site

Public Types

typedef std::vector< SiteSiteList

Public Member Functions

 SiteConfig ()
bool Complete (bool aSiteGridUsed)
 This is called when all of the input has been read.
bool CreatePlatforms (Simulation &aSimulation, const Task &aTask) const
bool ProcessInput (UtInput &aInput)
bool ProcessSiteGridInput (UtInput &aInput)
int GetPointCount () const
 Returns the number of site points/cases.
int GetGridDrCount () const
int GetGridCrCount () const
double GetGridDrMin () const
double GetGridDrMax () const
double GetGridDrStep () const
double GetGridCrMin () const
double GetGridCrMax () const
double GetGridCrStep () const
void GetRunPosition (int aTargetIndex, double &aX, double &aY) const
void SetGridPointCount (int aCount)

Member Typedef Documentation

◆ SiteList

typedef std::vector<Site> engage::SiteConfig::SiteList

Constructor & Destructor Documentation

◆ SiteConfig()

engage::SiteConfig::SiteConfig ( )

Member Function Documentation

◆ Complete()

bool engage::SiteConfig::Complete ( bool aSiteGridUsed)

This is called when all of the input has been read.

References GetRunPosition(), and ok.

◆ CreatePlatforms()

◆ GetGridCrCount()

int engage::SiteConfig::GetGridCrCount ( ) const
inline

◆ GetGridCrMax()

double engage::SiteConfig::GetGridCrMax ( ) const
inline

◆ GetGridCrMin()

double engage::SiteConfig::GetGridCrMin ( ) const
inline

◆ GetGridCrStep()

double engage::SiteConfig::GetGridCrStep ( ) const
inline

◆ GetGridDrCount()

int engage::SiteConfig::GetGridDrCount ( ) const
inline

◆ GetGridDrMax()

double engage::SiteConfig::GetGridDrMax ( ) const
inline

◆ GetGridDrMin()

double engage::SiteConfig::GetGridDrMin ( ) const
inline

◆ GetGridDrStep()

double engage::SiteConfig::GetGridDrStep ( ) const
inline

◆ GetPointCount()

int engage::SiteConfig::GetPointCount ( ) const
inline

Returns the number of site points/cases.

Referenced by engage::TaskOutput::ResetSummary().

◆ GetRunPosition()

void engage::SiteConfig::GetRunPosition ( int aSiteIndex,
double & aX,
double & aY ) const

Determine the site location for a specific index Note that altitude is not determined, as currently a site is fixed at altitude 0

Referenced by Complete(), and engage::TaskOutput::InsertPk().

◆ ProcessInput()

◆ ProcessSiteGridInput()

bool engage::SiteConfig::ProcessSiteGridInput ( UtInput & aInput)

◆ SetGridPointCount()

void engage::SiteConfig::SetGridPointCount ( int aCount)
inline

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved