WSF
Public Types | Public Member Functions | List of all members
WsfSA_Group Class Reference

#include <WsfSA_Group.hpp>

Inheritance diagram for WsfSA_Group:
Inheritance graph
[legend]
Collaboration diagram for WsfSA_Group:
Collaboration graph
[legend]

Public Types

using ElementList = std::list<WsfSA_EntityPerception*>
Public Types inherited from WsfSA_PerceivedItem
enum  Identification {
  UNKNOWN = 0 , FRIENDLY = 1 , NEUTRAL = 2 , BOGIE = 3 ,
  BANDIT = 4
}
enum  ItemType { ENTITY = 0 , GROUP = 1 }
enum  Importance { IGNORED = 0 , NOMINAL = 1 , IMPORTANT = 2 }

Public Member Functions

 WsfSA_Group ()=default
 WsfSA_Group (const WsfPlatform *aOwningPlatform)
 ~WsfSA_Group () override
 WsfSA_Group (const WsfSA_Group &aSrc)
WsfSA_Group * Clone () const
bool IsSame (const WsfSA_PerceivedItem *aOther) const override
const char * GetScriptClassName () const override
ItemType GetItemType () const override
double GetLat_deg () const override
void SetLat_deg (double aLat_deg) override
double GetLon_deg () const override
void SetLon_deg (double aLon_deg) override
double GetAltitude_ft () const override
void SetAltitude_ft (double aAltitude_ft) override
double GetSpeed_kts () const override
void SetSpeed_kts (double aSpeed_kts) override
double GetHeading_deg () const override
void SetHeading_deg (double aHeading_deg) override
Importance GetImportance () const override
void SetImportance (Importance aImportance) override
Identification GetIdentification () const override
void SetIdentification (Identification aIdent) override
std::string GetPerceivedName () const override
void SetPerceivedName (const std::string &aIdString) override
bool GetAngleOnly () const override
void SetAngleOnly (bool aAngleOnly) override
float GetRadiusCurrent_nm () const
void SetRadiusCurrent_nm (float aValue)
float GetRadiusMinimum_nm () const
void SetRadiusMinimum_nm (float aValue)
double GetLastUpdateTime_sec () const
void SetLastUpdateTime_sec (double aValue)
bool GetFocus () const
void SetFocus (bool aFocus)
bool GetElementProtection () const
void SetElementProtection (bool aProtectElements)
bool GetFocusProtection () const
void SetFocusProtection (bool aProtectFocus)
size_t GetNumElements () const
const ElementList & GetElementList () const
void SetElementList (const ElementList &aList)
ElementList * ModifiableElementList ()
bool AddElement (WsfSA_EntityPerception *aElement)
bool RemoveElement (WsfSA_EntityPerception *aElement)
double EstimatedTimeToIntercept (WsfPlatform *aTarget) const override
 Returns an estimate of the time for this entity to intercept the specified platform.
Public Member Functions inherited from WsfSA_PerceivedItem
 WsfSA_PerceivedItem ()
 WsfSA_PerceivedItem (const WsfPlatform *aOwningPlatform)
 WsfSA_PerceivedItem (const WsfSA_PerceivedItem &aSrc)
WsfSA_PerceivedItem & operator= (const WsfSA_PerceivedItem &aRhs)
bool operator== (const WsfSA_PerceivedItem &aRhs)=delete
bool operator!= (const WsfSA_PerceivedItem &aRhs)=delete
const char * GetScriptClassName () const override
double CalcRangeForPlatform (const WsfPlatform *aPlatform)
double AngleOffHeadingFromOwningPlatform_deg ()
 Find the angle off heading from this PI's owning platform, in degrees -180 to 180.
const WsfPlatform * OwningPlatform () const
void OwningPlatform (const WsfPlatform *aPlatform)
bool PerceptionIsMalformed () const
void SetMalformedCondition ()
virtual double GetBearing_deg () const
virtual void SetBearing_deg (double aBearing_deg)
virtual double GetThreatLevel () const
virtual void SetThreatLevel (double aThreatLevel)
virtual double GetTargetValue () const
virtual void SetTargetValue (double aTargetValue)
virtual bool GetAltitudeValid () const
virtual void SetAltitudeValid (bool aSetting)
virtual bool GetSpeedValid () const
virtual void SetSpeedValid (bool aSetting)
virtual bool GetHeadingValid () const
virtual void SetHeadingValid (bool aSetting)
virtual double GetSelectionScore () const
virtual void SetSelectionScore (double aSelectionScore)

Additional Inherited Members

Static Public Member Functions inherited from WsfSA_PerceivedItem
static double GetAssumedRangeForAngleOnlyTargets ()
static void SetAssumedRangeForAngleOnlyTargets (double aRange)
static bool CompareScoreLowGood (const WsfSA_PerceivedItem *aFirstItem, const WsfSA_PerceivedItem *aSecondItem)
static bool CompareScoreHighGood (const WsfSA_PerceivedItem *aFirstItem, const WsfSA_PerceivedItem *aSecondItem)
static bool CompareThreatLevelHighGood (const WsfSA_PerceivedItem *aFirstItem, const WsfSA_PerceivedItem *aSecondItem)
static bool CompareTargetValueHighGood (const WsfSA_PerceivedItem *aFirstItem, const WsfSA_PerceivedItem *aSecondItem)
Static Public Attributes inherited from WsfSA_PerceivedItem
static double mAssumedRangeForAngleOnlyTargets = 2.0e13

Member Typedef Documentation

◆ ElementList

using WsfSA_Group::ElementList = std::list<WsfSA_EntityPerception*>

Constructor & Destructor Documentation

◆ WsfSA_Group() [1/3]

WsfSA_Group::WsfSA_Group ( )
default

Referenced by Clone(), IsSame(), and WsfSA_Group().

◆ WsfSA_Group() [2/3]

WsfSA_Group::WsfSA_Group ( const WsfPlatform * aOwningPlatform)
inlineexplicit

References WsfSA_PerceivedItem::WsfSA_PerceivedItem().

◆ ~WsfSA_Group()

WsfSA_Group::~WsfSA_Group ( )
override

◆ WsfSA_Group() [3/3]

WsfSA_Group::WsfSA_Group ( const WsfSA_Group & aSrc)

References WsfSA_Group(), and WsfSA_PerceivedItem::WsfSA_PerceivedItem().

Member Function Documentation

◆ AddElement()

bool WsfSA_Group::AddElement ( WsfSA_EntityPerception * aElement)

References WsfSA_EntityPerception::GetParentGroup(), and WsfSA_EntityPerception::SetParentGroup().

Referenced by WsfSA_GroupManager::AttemptToJoinBestGroup(), WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupManager::FormDegenerateGroup(), WsfSA_GroupUtils::RemoveEntityFromGroup(), and WsfSA_GroupUtils::TransferEntity().

◆ Clone()

WsfSA_Group * WsfSA_Group::Clone ( ) const
inline

References WsfSA_Group().

◆ EstimatedTimeToIntercept()

double WsfSA_Group::EstimatedTimeToIntercept ( WsfPlatform * aTarget) const
overridevirtual

Returns an estimate of the time for this entity to intercept the specified platform.

If no intercept is possible, -1.0 will be returned. If the entity is angle-only, or if it lacks speed data, no intercept will be calculated and -1.0 will be returned.

Parameters
aTargetpointer to the platform being considered

Implements WsfSA_PerceivedItem.

References GetAltitude_ft(), WsfSA_PerceivedItem::GetAltitudeValid(), GetLat_deg(), GetLon_deg(), GetSpeed_kts(), WsfSA_PerceivedItem::GetSpeedValid(), and WsfIntercept::Intercept().

◆ GetAltitude_ft()

double WsfSA_Group::GetAltitude_ft ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::DistanceFromCentroid(), EstimatedTimeToIntercept(), and WsfSA_GroupUtils::SortedGroups().

◆ GetAngleOnly()

bool WsfSA_Group::GetAngleOnly ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

◆ GetElementList()

const ElementList & WsfSA_Group::GetElementList ( ) const
inline

Referenced by WsfSA_GroupUtils::CalcRadiusForGroup_nm(), WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupUtils::RecalculateGroupCentroid(), and WsfSA_GroupUtils::SplitGroup().

◆ GetElementProtection()

bool WsfSA_Group::GetElementProtection ( ) const
inline

Referenced by WsfSA_GroupManager::AttemptToJoinBestGroup().

◆ GetFocus()

bool WsfSA_Group::GetFocus ( ) const
inline

Referenced by WsfSA_GroupUtils::DisbandGroup(), WsfSA_Perceive::GetFocus(), WsfSA_GroupUtils::MergeGroups(), WsfSA_GroupUtils::RemoveEntityFromGroup(), WsfSA_GroupUtils::SetFocus(), WsfSA_GroupUtils::SplitGroup(), and WsfSA_GroupUtils::TransferEntity().

◆ GetFocusProtection()

bool WsfSA_Group::GetFocusProtection ( ) const
inline

◆ GetHeading_deg()

double WsfSA_Group::GetHeading_deg ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

◆ GetIdentification()

WsfSA_PerceivedItem::Identification WsfSA_Group::GetIdentification ( ) const
overridevirtual

Implements WsfSA_PerceivedItem.

References WsfSA_PerceivedItem::BANDIT, WsfSA_PerceivedItem::BOGIE, WsfSA_PerceivedItem::FRIENDLY, WsfSA_PerceivedItem::NEUTRAL, and WsfSA_PerceivedItem::UNKNOWN.

◆ GetImportance()

WsfSA_PerceivedItem::Importance WsfSA_Group::GetImportance ( ) const
overridevirtual

Implements WsfSA_PerceivedItem.

References WsfSA_PerceivedItem::IMPORTANT.

Referenced by SetImportance().

◆ GetItemType()

ItemType WsfSA_Group::GetItemType ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

References WsfSA_PerceivedItem::GROUP.

◆ GetLastUpdateTime_sec()

double WsfSA_Group::GetLastUpdateTime_sec ( ) const
inline

◆ GetLat_deg()

double WsfSA_Group::GetLat_deg ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::DistanceFromCentroid(), and EstimatedTimeToIntercept().

◆ GetLon_deg()

double WsfSA_Group::GetLon_deg ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::DistanceFromCentroid(), and EstimatedTimeToIntercept().

◆ GetNumElements()

size_t WsfSA_Group::GetNumElements ( ) const
inline

Referenced by WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupUtils::SetFocus(), WsfSA_GroupUtils::SortedGroups(), and WsfSA_GroupUtils::SplitGroup().

◆ GetPerceivedName()

std::string WsfSA_Group::GetPerceivedName ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by IsSame(), SetImportance(), and WsfSA_GroupUtils::SplitGroup().

◆ GetRadiusCurrent_nm()

float WsfSA_Group::GetRadiusCurrent_nm ( ) const
inline

Referenced by WsfSA_GroupUtils::CalcRadiusForGroup_nm(), and WsfSA_GroupUtils::SortedGroups().

◆ GetRadiusMinimum_nm()

float WsfSA_Group::GetRadiusMinimum_nm ( ) const
inline

Referenced by WsfSA_GroupUtils::CalcRadiusForGroup_nm().

◆ GetScriptClassName()

const char * WsfSA_Group::GetScriptClassName ( ) const
inlineoverride

◆ GetSpeed_kts()

double WsfSA_Group::GetSpeed_kts ( ) const
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by EstimatedTimeToIntercept().

◆ IsSame()

bool WsfSA_Group::IsSame ( const WsfSA_PerceivedItem * aOther) const
overridevirtual

Implements WsfSA_PerceivedItem.

References WsfSA_PerceivedItem::GetItemType(), GetPerceivedName(), WsfSA_PerceivedItem::GROUP, WsfSA_Group(), and WsfSA_PerceivedItem::WsfSA_PerceivedItem().

◆ ModifiableElementList()

ElementList * WsfSA_Group::ModifiableElementList ( )
inline

◆ RemoveElement()

bool WsfSA_Group::RemoveElement ( WsfSA_EntityPerception * aElement)

References WsfSA_EntityPerception::GetParentGroup(), and WsfSA_EntityPerception::SetParentGroup().

Referenced by WsfSA_GroupUtils::DisbandGroup(), and WsfSA_GroupUtils::RemoveEntityFromGroup().

◆ SetAltitude_ft()

void WsfSA_Group::SetAltitude_ft ( double aAltitude_ft)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::RecalculateGroupCentroid().

◆ SetAngleOnly()

void WsfSA_Group::SetAngleOnly ( bool aAngleOnly)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

◆ SetElementList()

void WsfSA_Group::SetElementList ( const ElementList & aList)

References WsfSA_EntityPerception::GetParentGroup(), and WsfSA_EntityPerception::SetParentGroup().

Referenced by WsfSA_GroupUtils::CreateGroup(), WsfSA_GroupUtils::MergeGroups(), and WsfSA_GroupUtils::SplitGroup().

◆ SetElementProtection()

void WsfSA_Group::SetElementProtection ( bool aProtectElements)
inline

Referenced by WsfSA_GroupUtils::CreateGroup(), WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupUtils::MergeGroups(), WsfSA_GroupUtils::RemoveEntityFromGroup(), WsfSA_GroupUtils::SplitGroup(), and WsfSA_GroupUtils::TransferEntity().

◆ SetFocus()

void WsfSA_Group::SetFocus ( bool aFocus)
inline

Referenced by WsfSA_GroupUtils::MergeGroups(), WsfSA_Perceive::Prune(), WsfSA_GroupUtils::SetFocus(), and WsfSA_GroupUtils::SplitGroup().

◆ SetFocusProtection()

void WsfSA_Group::SetFocusProtection ( bool aProtectFocus)
inline

Referenced by WsfSA_GroupUtils::SetFocus().

◆ SetHeading_deg()

void WsfSA_Group::SetHeading_deg ( double aHeading_deg)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::RecalculateGroupCentroid().

◆ SetIdentification()

void WsfSA_Group::SetIdentification ( Identification aIdent)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

◆ SetImportance()

void WsfSA_Group::SetImportance ( Importance aImportance)
overridevirtual

Implements WsfSA_PerceivedItem.

References GetImportance(), and GetPerceivedName().

◆ SetLastUpdateTime_sec()

void WsfSA_Group::SetLastUpdateTime_sec ( double aValue)
inline

◆ SetLat_deg()

void WsfSA_Group::SetLat_deg ( double aLat_deg)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::RecalculateGroupCentroid().

◆ SetLon_deg()

void WsfSA_Group::SetLon_deg ( double aLon_deg)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::RecalculateGroupCentroid().

◆ SetPerceivedName()

void WsfSA_Group::SetPerceivedName ( const std::string & aIdString)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::CreateGroup(), WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupManager::FormDegenerateGroup(), WsfSA_GroupUtils::MergeGroups(), WsfSA_GroupUtils::RemoveEntityFromGroup(), WsfSA_GroupUtils::RenameGroup(), and WsfSA_GroupUtils::SplitGroup().

◆ SetRadiusCurrent_nm()

void WsfSA_Group::SetRadiusCurrent_nm ( float aValue)
inline

Referenced by WsfSA_GroupManager::FormDegenerateGroup(), and WsfSA_GroupUtils::RecalculateGroupCentroid().

◆ SetRadiusMinimum_nm()

void WsfSA_Group::SetRadiusMinimum_nm ( float aValue)
inline

Referenced by WsfSA_GroupUtils::CreateGroup(), WsfSA_GroupUtils::DisbandGroup(), WsfSA_GroupManager::FormDegenerateGroup(), WsfSA_GroupUtils::MergeGroups(), WsfSA_GroupUtils::RemoveEntityFromGroup(), and WsfSA_GroupUtils::SplitGroup().

◆ SetSpeed_kts()

void WsfSA_Group::SetSpeed_kts ( double aSpeed_kts)
inlineoverridevirtual

Implements WsfSA_PerceivedItem.

Referenced by WsfSA_GroupUtils::RecalculateGroupCentroid().

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