#include <WsfNoiseCloud.hpp>

Inheritance diagram for WsfNoiseCloud:

Collaboration diagram for WsfNoiseCloud:

Public Types
typedef std::map< WsfStringId, double >	ModifierList
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfNoiseCloud ()
	Constructor.
WsfNoiseCloud &	operator= (const WsfNoiseCloud &)=delete
	~WsfNoiseCloud () override
	Destructor.
WsfNoiseCloud *	Clone () const override
	Standard Clone() method.
bool	ProcessInput (UtInput &aInput) override
double	CheckIntersections (double aSimTime, const double aLLA1[3], const double aLLA2[3])
void	Initialize (WsfSimulation &aSimulation)
virtual const ModifierList &	GetModifierList ()
	Get the modifier list for WsfZoneAttenuation.
double	GetHeight () 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 Member Functions
static void	GetCurrentTypes (std::vector< WsfNoiseCloud * > &aTypeList)

Protected Member Functions
	WsfNoiseCloud (const WsfNoiseCloud &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

Noise clouds are used for weather effects on sensor and comm propagation.

Noise clouds are built from noise functions as defined in UtNoise.

Member Typedef Documentation

◆ ModifierList

typedef std::map<WsfStringId, double> WsfNoiseCloud::ModifierList

Constructor & Destructor Documentation

◆ WsfNoiseCloud() [1/2]

WsfNoiseCloud::WsfNoiseCloud ( )

Constructor.

Referenced by Clone(), operator=(), and WsfNoiseCloud().

◆ ~WsfNoiseCloud()

WsfNoiseCloud::~WsfNoiseCloud ( )

override

Destructor.

◆ WsfNoiseCloud() [2/2]

WsfNoiseCloud::WsfNoiseCloud ( const WsfNoiseCloud & aSrc )

protected

Copy constructor (for Clone()).

Copy constructor.

References WsfNoiseCloud().

Member Function Documentation

◆ CheckIntersections()

double WsfNoiseCloud::CheckIntersections	(	double	aSimTime,
		const double	aLLA1[3],
		const double	aLLA2[3] )

References WsfGeoPoint::GetLocationWCS(), and WsfGeoPoint::SetLocationLLA().

Referenced by operator=().

◆ Clone()

WsfNoiseCloud * WsfNoiseCloud::Clone ( ) const

overridevirtual

Standard Clone() method.

Implements WsfObject.

References WsfNoiseCloud().

◆ GetCurrentTypes()

void WsfNoiseCloud::GetCurrentTypes ( std::vector< WsfNoiseCloud * > & aTypeList )

static

◆ GetHeight()

double WsfNoiseCloud::GetHeight ( ) const

inline

◆ GetModifierList()

virtual const ModifierList & WsfNoiseCloud::GetModifierList ( )

inlinevirtual

Get the modifier list for WsfZoneAttenuation.

◆ Initialize()

void WsfNoiseCloud::Initialize ( WsfSimulation & aSimulation )

References WsfScenario::GetEnvironment(), WsfSimulation::GetRandom(), WsfSimulation::GetScenario(), WsfEnvironment::GetWindDirection(), and WsfEnvironment::GetWindSpeed().

Referenced by operator=().

◆ operator=()

WsfNoiseCloud & WsfNoiseCloud::operator= ( const WsfNoiseCloud & )

delete

References CheckIntersections(), Initialize(), and WsfNoiseCloud().

◆ ProcessInput()

bool WsfNoiseCloud::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.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions