#include <WsfPlatformAvailability.hpp>

Public Member Functions
	WsfPlatformAvailability ()
bool	PlatformIsAvailable (WsfPlatform *aPlatformPtr, WsfSimulation &aSimulation) const
bool	ProcessInput (UtInput &aInput)
void	SetDefaultAvailability (double aProbability)
void	SetAvailabilityByName (WsfStringId aName, double aAvailability)

Detailed Description

Determines platform availability from a list of criteria specified in the input file If a platform is not available, the simulation will not create the platform.

Constructor & Destructor Documentation

◆ WsfPlatformAvailability()

WsfPlatformAvailability::WsfPlatformAvailability ( )

Member Function Documentation

◆ PlatformIsAvailable()

bool WsfPlatformAvailability::PlatformIsAvailable	(	WsfPlatform *	aPlatformPtr,
		WsfSimulation &	aSimulation ) const

Determine if the specified input platform should be added to the simulation. A user may specify that an input platform should be eliminated from the simulation. This may be unconditional or based on a random number. This allows platforms to be be excluded without having to explicitly modify the scenario.

References WsfObjectTypeList< T >::Find(), WsfZoneTypes::Get(), WsfPlatform::GetCategories(), WsfCategoryList::GetCategoryList(), WsfPlatform::GetMover(), WsfObject::GetNameId(), WsfSimulation::GetRandom(), WsfSimulation::GetScenario(), WsfMover::GetSpatialDomain(), WsfPlatform::GetSpatialDomain(), WsfObject::GetTypeList(), WsfZone::PointIsInside(), WSF_SPATIAL_DOMAIN_LAND, WSF_SPATIAL_DOMAIN_SPACE, and WSF_SPATIAL_DOMAIN_UNKNOWN.

◆ ProcessInput()

bool WsfPlatformAvailability::ProcessInput ( UtInput & aInput )

◆ SetAvailabilityByName()

void WsfPlatformAvailability::SetAvailabilityByName	(	WsfStringId	aName,
		double	aAvailability )

inline

◆ SetDefaultAvailability()

void WsfPlatformAvailability::SetDefaultAvailability ( double aProbability )