A grid that specifies its separation between points as a length across the surface of the Earth. More...

#include <WsfCoverageDistanceSteppedGrid.hpp>

Inheritance diagram for wsf::coverage::DistanceSteppedGrid:

[legend]

Collaboration diagram for wsf::coverage::DistanceSteppedGrid:

[legend]

Public Member Functions
	DistanceSteppedGrid (const WsfScenario &aScenario)
	DistanceSteppedGrid (const DistanceSteppedGrid &aOther)=default
	~DistanceSteppedGrid () override=default
DistanceSteppedGrid *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
double	GetLatStepDistance () const
	Return the distance in meters between adjacent grid points in the N-S direction.
double	GetLonStepDistance () const
	Return the distance in meters between adjacent grid points in the E-W direction.
int	GetNumLatSteps () const
	Return the number of grid points in the N-S direction.
int	GetNumLonSteps () const
	Return the number of grid points in the E-W direction.
int	GetLatOriginIndex () const
	Return the index in the grid of the origin in the N-S direction.
int	GetLonOriginIndex () const
	Return the index in the grid of the origin in the E-W direction.
Public Member Functions inherited from wsf::coverage::RectangularGrid
	RectangularGrid (const WsfScenario &aScenario)
	RectangularGrid (const RectangularGrid &aOther)
	~RectangularGrid () override=default
bool	ProcessInput (UtInput &aInput) override
void	PreparePlatforms (WsfSimulation &aSimulation) override
const Point *	GetPoint (PointId aPointId) const override
std::size_t	GetSize () const override
void	Invoke (GridAction &aAction) const override
GridAsset	GetAsset (PointId aPointId) const override
GridAsset	GetAsset (const std::string &aPlatformName) const override
void	HasNullDevice (bool &aAnyNull, bool &aAllNull) const override
bool	CreatesNewPlatforms () const override
bool	IsStructured () const override
std::pair< std::size_t, std::size_t >	GetComponentSizes (std::size_t aComponentIndex) const override
std::pair< std::size_t, std::size_t >	GetPointIndices (PointId aPointId) const override
const std::string &	GetAssetPlatformType () const
	Return the platform type of the assets for this grid.
const std::string &	GetAssetDeviceName () const
	Return the device name for the assets for this grid.
double	GetAltitude () const
	Return the altitude of the grid points.
bool	IsAltitudeAGL () const
double	GetLatitudeOriginDeg () const
	Get the origin point in latitude.
double	GetLongitudeOriginDeg () const
	Get the origin point in longitude.
Public Member Functions inherited from wsf::coverage::Grid
	Grid (const WsfScenario &aScenario)
	Grid (const Grid &aOther)=default
	~Grid () override=default
virtual std::size_t	GetNumComponents () const
virtual std::string	GetComponentName (std::size_t aComponentIndex) const
	Return the name of the specified grid component.
virtual void	InvokeOnComponent (GridAction &aAction, std::size_t aComponentIndex) const
	Invoke the given `aAction` on the points of the specified grid component.
void	SetUsedFlag ()
bool	IsUsed () const
bool	Initialize ()
void	CategorizeAssets (const WsfSimulation &aSimulation, const std::string &aCategory) const
bool	IsInitialized () const
	Return if this Grid has been initialized.
const ut::CentralBody &	GetCentralBody () const
	Return the central body to which this grid's point locations refer.
void	SetCentralBody (const ut::CentralBody &aCentralBody)
	Set the central body of this grid.
const std::string &	GetGridDataFileName () const
	Return the configured grid data file name.
bool	GetSuppressGridPlatforms () const
	Return if this grid is suppressing grid platforms.
void	SetSuppressGridPlatforms (bool aSuppress)
	Set if this grid suppresses grid platforms.
bool	WriteGridDataFile (TextOutputWriter &aWriter) const
bool	WriteGridDataFile () const
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Static Public Attributes
static constexpr const char *	cTYPE {"WSF_DISTANCE_STEPPED_GRID"}

Protected Member Functions
bool	InitializeP () override
Protected Member Functions inherited from wsf::coverage::RectangularGrid
bool	CreateRectangularGrid ()
std::string	GetPlatformName (PointId aPointId) const
Protected Member Functions inherited from wsf::coverage::Grid
PointId	GetNextAvailableId ()
const WsfScenario &	GetScenario () const
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Attributes inherited from wsf::coverage::RectangularGrid
std::string	mPlatformType {}
std::string	mDeviceName {}
double	mAltitude {0.0}
double	mLatOriginDeg {}
double	mLonOriginDeg {}
size_t	mLatSize {}
size_t	mLonSize {}
std::map< PointId, Point >	mPoints {}
std::map< PointId, std::pair< std::size_t, std::size_t > >	mIndices {}
std::map< std::string, GridAsset >	mAssets {}
bool	mOriginSet {false}
bool	mAltitudeAGL {false}

Detailed Description

A grid that specifies its separation between points as a length across the surface of the Earth.

Constructor & Destructor Documentation

◆ DistanceSteppedGrid() [1/2]

wsf::coverage::DistanceSteppedGrid::DistanceSteppedGrid ( const WsfScenario & aScenario )

inlineexplicit

References wsf::coverage::RectangularGrid::RectangularGrid().

Referenced by Clone(), and DistanceSteppedGrid().

◆ DistanceSteppedGrid() [2/2]

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

default

References DistanceSteppedGrid().

◆ ~DistanceSteppedGrid()

wsf::coverage::DistanceSteppedGrid::~DistanceSteppedGrid ( )

overridedefault

Member Function Documentation

◆ Clone()

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

inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements wsf::coverage::Grid.

References DistanceSteppedGrid().

◆ GetLatOriginIndex()

int wsf::coverage::DistanceSteppedGrid::GetLatOriginIndex ( ) const

inline

Return the index in the grid of the origin in the N-S direction.

◆ GetLatStepDistance()

double wsf::coverage::DistanceSteppedGrid::GetLatStepDistance ( ) const

inline

Return the distance in meters between adjacent grid points in the N-S direction.

◆ GetLonOriginIndex()

int wsf::coverage::DistanceSteppedGrid::GetLonOriginIndex ( ) const

inline

Return the index in the grid of the origin in the E-W direction.

◆ GetLonStepDistance()

double wsf::coverage::DistanceSteppedGrid::GetLonStepDistance ( ) const

inline

Return the distance in meters between adjacent grid points in the E-W direction.

◆ GetNumLatSteps()

int wsf::coverage::DistanceSteppedGrid::GetNumLatSteps ( ) const

inline

Return the number of grid points in the N-S direction.

◆ GetNumLonSteps()

int wsf::coverage::DistanceSteppedGrid::GetNumLonSteps ( ) const

inline

Return the number of grid points in the E-W direction.

◆ InitializeP()

bool wsf::coverage::DistanceSteppedGrid::InitializeP ( )

overrideprotectedvirtual

Grid type specific initialization.

Initialization specific to the grid type occurs in this method. In particular, validation on input quantities should occur here. The set of grid points should be defined after this method's successful return, and both GetAsset methods should return valid GridAsset instances for any point in this grid.

Returns: true if initialization is successful; false otherwise.

Implements wsf::coverage::Grid.

References wsf::coverage::RectangularGrid::CreateRectangularGrid(), WsfObject::GetName(), wsf::coverage::RectangularGrid::mDeviceName, wsf::coverage::RectangularGrid::mOriginSet, and wsf::coverage::RectangularGrid::mPlatformType.

◆ ProcessInput()

bool wsf::coverage::DistanceSteppedGrid::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References wsf::coverage::RectangularGrid::ProcessInput().

Member Data Documentation

◆ cTYPE

const char* wsf::coverage::DistanceSteppedGrid::cTYPE {"WSF_DISTANCE_STEPPED_GRID"}

staticconstexpr

Referenced by wsf::coverage::GridTypes::GridTypes().

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DistanceSteppedGrid() [1/2]

◆ DistanceSteppedGrid() [2/2]

◆ ~DistanceSteppedGrid()

Member Function Documentation

◆ Clone()

◆ GetLatOriginIndex()

◆ GetLatStepDistance()

◆ GetLonOriginIndex()

◆ GetLonStepDistance()

◆ GetNumLatSteps()

◆ GetNumLonSteps()

◆ InitializeP()

◆ ProcessInput()

Member Data Documentation

◆ cTYPE