WSF
WsfRIPRProcessor Class Reference

#include <WsfRIPRProcessor.hpp>

Inheritance diagram for WsfRIPRProcessor:
Collaboration diagram for WsfRIPRProcessor:

Classes

struct  ActiveWeapon
struct  WeaponStatus

Public Types

using ActiveWeaponList = std::list<ActiveWeapon>
using ActiveWeaponListIter = std::list<ActiveWeapon>::iterator
using WeaponStatusList = std::list<WeaponStatus>
using WeaponStatusListIter = std::list<WeaponStatus>::iterator
using ComponentList = WsfComponentListT<WsfProcessorComponent>
Public Types inherited from WsfPlatformPart
enum  { cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using InternalMessageQueue = std::queue<WsfMessage*>
using RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart*, WsfMessage*>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform ParentType
 This is needed to support the WsfComponentList template.

Public Member Functions

 WsfRIPRProcessor (WsfScenario &aScenario, const char *aPretendName, bool aJobPassThrough=false)
 WsfRIPRProcessor (WsfScenario &aScenario, bool aJobPassThrough=false)
 WsfRIPRProcessor (WsfScenario &aScenario, const std::string &aPartClass, const std::string &aPartVarName, bool aJobPassThrough=false)
WsfRIPRProcessoroperator= (const WsfRIPRProcessor &)=delete
 ~WsfRIPRProcessor () override
void BiddingHijacked (bool aValue)
bool BiddingHijacked () const
 True means script calls to set bids for this processor are n.
WsfProcessorClone () const override
bool Initialize (double aSimTime) override
bool Initialize2 (double aSimTime) override
void Update (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
const char * GetScriptClassName () const override
virtual bool RegisterScriptBiddingBlock (std::string aJobType, WsfScriptContext *aContextPtr, UtScript *aScriptPtr)
virtual bool UnregisterScriptBiddingBlock (std::string aJobType)
unsigned int GetId (unsigned int aIndex=0)
unsigned int NumJobChannels () const
void SetNumJobChannels (unsigned int aNumChannels)
int JobChannelByProcId (unsigned int aRIPRProcId)
ripr::JobChannelIdList JobChannelIds () const
 Returns a copy of the Job Channels Id list.
std::vector< unsigned int > JobTypeChannels (std::string aJobType)
std::vector< std::string > ChannelJobTypes (unsigned int aChannelIndex)
bool ValidJobTypeChannel (std::string aJobType, unsigned int aChannelIndex)
double WallClock ()
bool ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
bool ReceiveMessage (double aSimTime, const WsfMessage &aMessage) override
WsfRIPRProcessorCommanderProcessor ()
WsfRIPRProcessorCommanderProcessor (const std::string &)
WsfPlatformCommanderPlatform ()
WsfPlatformCommanderPlatform (const std::string &)
std::vector< WsfRIPRProcessor * > SubordinateProcessors ()
std::vector< WsfRIPRProcessor * > SubordinateProcessors (const std::string &aCommandChainName)
std::vector< WsfPlatform * > SubordinatePlatforms ()
std::vector< WsfPlatform * > SubordinatePlatforms (const std::string &aCommandChainName)
double QuerySubordinatesMaxBid (WsfRIPRJob &aJob, bool expandPassThroughAgents=true)
std::vector< WsfPlatform * > Subordinates ()
ripr::RIPRCommanderList Commanders ()
virtual WsfRIPRJobBoardJobBoard ()
void SetJobPassThrough (bool aJobPassThrough)
bool JobPassThrough ()
bool JobWindowOpen (double aSimTime)
bool BidWindowOpen (double aSimTime)
void SetJobWindowOpen (bool aOpen)
void SetBidWindowOpen (bool aOpen)
void SetJobStickiness (double aStickiness)
double QueryBid (WsfRIPRJob &aJob)
wsf::comm::CommJobBoardComm ()
void SetJobBoardComm (wsf::comm::Comm *aCommPtr)
void SendMessageJobAward (wsf::comm::Comm *aCommPtr, WsfRIPRProcessor *aSourcePtr, int aChannelIndex, int aJobId)
WsfRIPRJobJobFor (double aSimTime, WsfRIPRProcessor *aProcPtr, int aChannelIndex)
int BufferedJobForChannel (int aChannelIndex)
void SetBufferedJobForChannel (int aChannelIndex, int aJob)
int Targeting (const WsfTrack *aTrackPtr)
int WeaponsActive (const WsfTrack &aTrack)
int WeaponsActiveOfType (const WsfWeapon &aWeapon)
int WeaponsActive ()
 Return the count of the number of weapons that are active.
WsfPlatformActiveWeaponPlatform (unsigned int aIndex)
 Return the platform of the active weapon at the given index.
int SubsTargeting (const WsfTrack *aTrackPtr, const WsfPlatform *aExcludePlatform=nullptr)
int SubsWeaponsActive (const WsfTrack *aTrackPtr, const WsfPlatform *aExcludePlatform=nullptr)
int PeersWeaponsActive (const WsfTrack &aTrack)
int PeersTargeting (const WsfTrack &aTrack)
std::vector< WsfPlatform * > WeaponsIncoming ()
std::string TargetName ()
WsfPlatformTargetPlatform ()
size_t TargetPlatformId ()
WsfTrackTargetTrack ()
bool SetTargetByName (std::string aTargetName)
bool SetTargetByPlatform (WsfPlatform *aPlatformPtr)
void SetTargetByPlatformId (size_t aTargetId)
bool SetTargetByTrack (WsfTrack *aTargetTrackPtr)
bool ClearTarget ()
WeaponStatusList::iterator FindWeaponStatus (const WsfTrackId &aTrackId, size_t aAssigneeIndex, WsfStringId aWeaponSystemName)
Public Member Functions inherited from WsfScriptProcessor
 WsfScriptProcessor (const WsfScenario &aScenario)
 WsfScriptProcessor (const WsfScenario &aScenario, WsfStringId aPartClass, const std::string &aPartVarName)
 ~WsfScriptProcessor () override
WsfProcessorClone () const override
bool Initialize (double aSimTime) override
bool Initialize2 (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
void Update (double aSimTime) override
bool ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
void SendMessage (double aSimTime, const WsfMessage &aMessage) override
virtual void ExecuteOnMessageCreate (double aSimTime, WsfMessage &aMessage)
virtual bool ExecuteScript (double aSimTime, const std::string &aScriptName)
virtual bool ExecuteScript (double aSimTime, WsfStringId aScriptName, UtScriptData &aScriptRetVal, const UtScriptDataList &aScriptArgs=UtScriptDataList())
void ExecuteScriptAtTime (double aTime, WsfStringId aScriptName, const UtScriptDataList &aScriptArgs)
virtual void SuppressMessage (bool aSuppressMessage)
WsfScriptMessageHandlerGetMessageHandler ()
WsfScriptContextGetScriptContext ()
UtScriptContext * GetScriptAccessibleContext () const override
void SetPlatform (WsfPlatform *aPlatformPtr) override
const WsfBehaviorTreeBehaviorTree () const
WsfAdvancedBehaviorTreeAdvancedBehaviorTree () const
virtual const WsfScriptStateMachineGetStateMachine () const
wsf::ExternalLinksGetExternalLinks ()
std::string State ()
std::string StateAll ()
void SetState (std::string &stateName)
void SetStateAll (std::string &stateNameAll)
Public Member Functions inherited from WsfProcessor
 WsfProcessor (const WsfScenario &aScenario)
 ~WsfProcessor () override=default
ComponentListGetComponents ()
const ComponentListGetComponents () const
virtual void ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponentCloneComponent () const override
const int * GetComponentRoles () const override
void * QueryInterface (int aRole) override
int GetComponentInitializationOrder () const override
const char * GetScriptClassName () const override
bool PreInitialize (double aSimTime) override
void PreInput () override
void TurnOff (double aSimTime) override
void TurnOn (double aSimTime) override
void SetNonOperational (double aSimTime) override
void SetOperational (double aSimTime) override
void PartBroken (double aSimTime) override
double GetUpdateInterval () const override
void SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
 WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPartoperator= (const WsfPlatformPart &aRhs)=delete
 ~WsfPlatformPart () override
bool DebugEnabled () const
 Returns 'true' if debugging is enabled for this instance.
void SetDebugEnabled (bool aDebugEnabled)
unsigned int GetDebugMask ()
bool IsExternallyControlled () const
virtual void SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int GetPartType () const
const char * GetScriptClassName () const override
WsfSimulationGetSimulation () const
const WsfScenarioGetScenario () const
WsfStringId GetComponentName () const override
void ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatformGetPlatform () const
virtual void PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void PlatformDeleted (WsfPlatform *aPlatformPtr)
double GetLastStatusChangeTime () const
void SetLastStatusChangeTime (double aSimTime)
 Allows a system to set the time at which the device was initialized.
bool CanBeMadeOperational () const
 Returns an indication that this system can be made operational.
bool CanBeMadeNonOperational () const
 Returns an indication that this system can be made non-operational.
bool CanBeTurnedOn () const
 Returns an indication that this system can be turned on.
bool CanBeTurnedOff () const
 Returns an indication that this system can be turned off.
bool IsTurnedOn () const
bool InitiallyTurnedOn () const
 Is the system to be turned 'on' when added to the simulation?
void SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
 Sets if the system is turned on when added to the simulation.
virtual void Restore (double aSimTime)
bool IsOperational () const
bool SetOperational (double aSimTime, bool aMakeOperational)
double GetDamageFactor () const
bool SetDamageFactor (double aSimTime, double aDamageFactor)
bool IsCritical () const
void SetCritical (bool aValue)
virtual void OnPlatformBrokenEvent (double aSimTime)
 Owning platform has issued a broken event.
bool IsBroken () const
WsfInternalLinksGetInternalLinks ()
 Return the internal links for this part.
virtual bool HasInternalLinks () const
 Does this platform part have a communication link to other platform parts?
virtual void SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void SendQueuedMessages (double aSimTime)
const WsfCategoryListGetCategories () const
 Get the categories to which this part belongs.
void AddCategory (WsfStringId aCategoryId)
 Adds the provided category to the platform part's category list.
bool IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupListGetGroups () const
 Get the groups to which this platform part belongs.
void JoinGroup (WsfGroup *aGroupPtr)
 Join the given group.
void LeaveGroup (WsfGroup *aGroupPtr)
 Leave the given group.
bool IsGroupMember (WsfStringId aGroupId)
unsigned int GetUpdateEventEpoch () const
void IncrementUpdateEventEpoch ()
bool UpdateEventActive () const
 Is an 'Update' event active?
void SetUpdateEventActive (bool aUpdateEventActive)
 Indicate if the 'Update' event is active.
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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
 WsfComponentT ()
 WsfComponentT (const WsfComponentT &) noexcept
WsfComponentToperator= (const WsfComponentT &) noexcept
 ~WsfComponentT () override=default
ParentTypeGetComponentParent () const
void SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual ~WsfComponent ()=default
template<typename T>
bool QueryInterfaceT (T *&aRolePtr)
bool ComponentHasRole (int aRole)
 Returns true if the component has the specified role.
Public Member Functions inherited from WsfUniqueId
 WsfUniqueId ()
 Construtor initializes the unique identifier to 0.
 WsfUniqueId (const WsfUniqueId &)
 Copy constructor initializes the unique identifier to 0.
WsfUniqueIdoperator= (const WsfUniqueId &)
unsigned int GetUniqueId () const
 Get the unique identifier assigned to this object.
template<typename T>
void Serialize (T &aBuff)
 For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
 WsfAuxDataEnabled ()=default
 WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabledoperator= (const WsfAuxDataEnabled &aRhs)
 WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabledoperator= (WsfAuxDataEnabled &&)=default
virtual ~WsfAuxDataEnabled () noexcept
void SetAuxData (const WsfAttributeContainer &aAuxData)
void DeleteAuxData ()
 Delete the aux data container from the object.
void MergeAuxData (const WsfAuxDataEnabled &aSrc)
 Merge the object's aux data with aux data from an existing object.
void UpdateAuxData (const WsfAuxDataEnabled &aSrc)
 Update the object's aux data with aux data from an existing object.
bool HasAuxData () const
 Returns true if this object has aux data.
bool ProcessInput (UtInput &aInput)
template<typename T>
void Serialize (T &aBuff)
 (De)serialization for XIO
WsfAttributeContainerGetAuxData ()
const WsfAttributeContainerGetAuxData () const noexcept
const WsfAttributeContainerGetAuxDataConst () const noexcept

Public Attributes

size_t mTargetPlatformIndex
UtCallbackHolder mCallbacks
ActiveWeaponList mActiveWeaponList
WeaponStatusList mWeaponStatusList

Simulation observer callbacks

using JobTypeIter = ripr::JobTypeChannelsMap::iterator
using QueryBidMapType = std::map<std::string, std::pair<WsfScriptContext*, UtScript*>>
WsfRIPRManagermManagerPtr
ripr::JobChannelIdList mJobChannelIds
ripr::JobTypeChannelsMap mJobTypeChannels
WsfRIPRJobBoardmJobBoardPtr
bool mJobPassThrough
std::vector< std::pair< std::string, UtScript * > > mBiddingBlocks
QueryBidMapType mQueryBidTypeMap
unsigned int mDesiredJobChannels
UtWallClock mRiprWallClock
bool mBiddingHijacked
 If true, this processor cannot bid from script calls.
wsf::comm::CommmJobBoardCommPtr
 pointer to the WsfComm object to be used by mJobBoard
WsfStringId mJobBoardCommInput
 nameid of the WsfComm object to stick in mJobBoardComm during initialize; read during process input
ripr::RIPRChannelJobMap mBufferedJobs
 map of which job id each channel id thinks it should currently be doing, indexed by job id
void WeaponFired (double aSimTime, const WsfWeaponEngagement *aEngagementPtr, const WsfTrack *aTargetTrackPtr)
void WeaponTerminated (double aSimTime, const WsfWeaponEngagement *aEngagementPtr)
void WeaponHit (double aSimTime, const WsfWeaponEngagement *aEngagementPtr, WsfPlatform *aTargetPlatformPtr)
void WeaponMissed (double aSimTime, const WsfWeaponEngagement *aEngagementPtr, WsfPlatform *aTargetPlatformPtr)
bool UplinkCapable ()
bool StartUplinking (size_t receiverIndex, size_t targetIndex=0)
bool StartUplinking (WsfPlatform *receiverPtr, WsfTrack *targetPtr=nullptr)
bool StopUplinking (size_t receiverIndex)
bool StopUplinking (WsfPlatform *receiverPtr)
bool IsUplinkingTo (int receiverIndex)
bool IsUplinkingTo (WsfPlatform *receiverPtr)
unsigned int WeaponUplinkCount ()
WsfPlatformUplinkWeaponPlatform (unsigned int aIndex)
 Return the weapon platform at aIndex in the list of the weapons currently being uplinked to.
WsfRIPRManagerGetManager () const
 WsfRIPRProcessor (const WsfRIPRProcessor &aSrc)
 Copy constructor (for Clone()).

Additional Inherited Members

Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataDestroyed
Protected Member Functions inherited from WsfScriptProcessor
 WsfScriptProcessor (const WsfScriptProcessor &aSrc)
 WsfProcessor (const WsfProcessor &aSrc)
 Copy constructor (for Clone()).
WsfProcessoroperator= (const WsfProcessor &aRhs)=delete
 WsfPlatformPart (const WsfPlatformPart &aSrc)
 Copy constructor (for Clone()).
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void AssignUniqueId (WsfSimulation *aSimulationPtr)
Protected Attributes inherited from WsfScriptProcessor
WsfScriptContextmContextPtr
 Pointer to the script context.
WsfScriptMessageHandlermMessageHandlerPtr
 Pointer to the 'on_message' handler.
UtScript * mOnMessageCreateScriptPtr
 Pointer to the 'on_message_create' script.
UtScriptClass * mMessageClassPtr
wsf::ExternalLinks mExternalLinks
 The external recipients.
WsfBehaviorTreemBehaviorTreePtr
ut::CloneablePtr< WsfAdvancedBehaviorTreemAdvancedBehaviorTreePtr
std::unique_ptr< WsfScriptStateMachinemStateMachinePtr
int mStateIndex
bool mSuppressMessage

Member Typedef Documentation

◆ ActiveWeaponList

◆ ActiveWeaponListIter

◆ JobTypeIter

using WsfRIPRProcessor::JobTypeIter = ripr::JobTypeChannelsMap::iterator
protected

◆ QueryBidMapType

using WsfRIPRProcessor::QueryBidMapType = std::map<std::string, std::pair<WsfScriptContext*, UtScript*>>
protected

◆ WeaponStatusList

◆ WeaponStatusListIter

Constructor & Destructor Documentation

◆ WsfRIPRProcessor() [1/4]

◆ WsfRIPRProcessor() [2/4]

◆ WsfRIPRProcessor() [3/4]

WsfRIPRProcessor::WsfRIPRProcessor ( WsfScenario & aScenario,
const std::string & aPartClass,
const std::string & aPartVarName,
bool aJobPassThrough = false )

◆ ~WsfRIPRProcessor()

WsfRIPRProcessor::~WsfRIPRProcessor ( )
override

◆ WsfRIPRProcessor() [4/4]

Member Function Documentation

◆ ActiveWeaponPlatform()

WsfPlatform * WsfRIPRProcessor::ActiveWeaponPlatform ( unsigned int aIndex)

Return the platform of the active weapon at the given index.

References WsfSimulation::GetPlatformByIndex(), WsfPlatformPart::GetSimulation(), and mActiveWeaponList.

◆ BiddingHijacked() [1/2]

bool WsfRIPRProcessor::BiddingHijacked ( ) const
inline

True means script calls to set bids for this processor are n.

References mBiddingHijacked.

Referenced by BiddingHijacked().

◆ BiddingHijacked() [2/2]

void WsfRIPRProcessor::BiddingHijacked ( bool aValue)

Hijack Bidding stops script calls from bidding for this processor. The reason you hijack bidding: 1) You want a human-in-the-loop to control bids.

References BiddingHijacked(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), mBiddingHijacked, and mManagerPtr.

Referenced by UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ BidWindowOpen()

bool WsfRIPRProcessor::BidWindowOpen ( double aSimTime)

References mJobBoardPtr.

◆ BufferedJobForChannel()

int WsfRIPRProcessor::BufferedJobForChannel ( int aChannelIndex)
inline

References mBufferedJobs.

Referenced by JobFor().

◆ ChannelJobTypes()

std::vector< std::string > WsfRIPRProcessor::ChannelJobTypes ( unsigned int aChannelIndex)

References mJobTypeChannels.

◆ ClearTarget()

bool WsfRIPRProcessor::ClearTarget ( )

◆ Clone()

WsfProcessor * WsfRIPRProcessor::Clone ( ) const
overridevirtual

Create a clone of this object.

Returns
A pointer to the new copy.

Implements WsfProcessor.

References WsfProcessor::WsfProcessor(), and WsfRIPRProcessor().

Referenced by WsfScriptRIPRProcessorClass::Clone().

◆ CommanderPlatform() [1/2]

WsfPlatform * WsfRIPRProcessor::CommanderPlatform ( )

◆ CommanderPlatform() [2/2]

◆ CommanderProcessor() [1/2]

◆ CommanderProcessor() [2/2]

◆ Commanders()

◆ FindWeaponStatus()

WsfRIPRProcessor::WeaponStatusList::iterator WsfRIPRProcessor::FindWeaponStatus ( const WsfTrackId & aTrackId,
size_t aAssigneeIndex,
WsfStringId aWeaponSystemName )

◆ GetId()

◆ GetManager()

WsfRIPRManager * WsfRIPRProcessor::GetManager ( ) const
inline

References mManagerPtr.

◆ GetScriptClassName()

const char * WsfRIPRProcessor::GetScriptClassName ( ) const
override

◆ Initialize()

bool WsfRIPRProcessor::Initialize ( double aSimTime)
overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfProcessor.

References WsfInternalLinks::AddRecipient(), WsfSimulation::FindExtension(), WsfAuxDataEnabled::GetAuxData(), WsfPlatformPart::GetInternalLinks(), WsfObject::GetName(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfUplinkProcessor::GetUplinkProcessor(), WsfUplinkProcessor::HasUplinkProcessor(), WsfScriptProcessor::Initialize(), mBiddingBlocks, mCallbacks, WsfScriptProcessor::mContextPtr, mDesiredJobChannels, mJobBoardCommInput, mJobChannelIds, mJobTypeChannels, mManagerPtr, ok, platformPtr, RegisterScriptBiddingBlock(), SetJobBoardComm(), SetNumJobChannels(), WsfObserver::WeaponFired(), WeaponFired(), WsfObserver::WeaponHit(), WeaponHit(), WsfObserver::WeaponMissed(), WeaponMissed(), WsfObserver::WeaponTerminated(), and WeaponTerminated().

◆ Initialize2()

bool WsfRIPRProcessor::Initialize2 ( double aSimTime)
overridevirtual

Perform phase 2 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 2 initialization of the platform. During phase 2, platform components may assume that the platform location has been defined, initial tracks have been loaded and that all components have completed phase 1 initialization.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfProcessor.

References WsfScriptProcessor::Initialize2(), and ok.

◆ IsUplinkingTo() [1/2]

bool WsfRIPRProcessor::IsUplinkingTo ( int receiverIndex)

◆ IsUplinkingTo() [2/2]

◆ JobBoard()

◆ JobBoardComm()

wsf::comm::Comm * WsfRIPRProcessor::JobBoardComm ( )
inline

References mJobBoardCommPtr.

Referenced by JobFor().

◆ JobChannelByProcId()

int WsfRIPRProcessor::JobChannelByProcId ( unsigned int aRIPRProcId)

◆ JobChannelIds()

ripr::JobChannelIdList WsfRIPRProcessor::JobChannelIds ( ) const
inline

Returns a copy of the Job Channels Id list.

References mJobChannelIds.

◆ JobFor()

◆ JobPassThrough()

bool WsfRIPRProcessor::JobPassThrough ( )
inline

References mJobPassThrough.

Referenced by QuerySubordinatesMaxBid().

◆ JobTypeChannels()

std::vector< unsigned int > WsfRIPRProcessor::JobTypeChannels ( std::string aJobType)

References mJobTypeChannels.

◆ JobWindowOpen()

bool WsfRIPRProcessor::JobWindowOpen ( double aSimTime)

References mJobBoardPtr.

◆ NumJobChannels()

unsigned int WsfRIPRProcessor::NumJobChannels ( ) const
inline

References mJobChannelIds.

Referenced by ~WsfRIPRProcessor().

◆ operator=()

WsfRIPRProcessor & WsfRIPRProcessor::operator= ( const WsfRIPRProcessor & )
delete

References WsfRIPRProcessor().

◆ PeersTargeting()

int WsfRIPRProcessor::PeersTargeting ( const WsfTrack & aTrack)

Return the count of the number of peers that are targeting the specified track. Includes all AIAI agents on same flight and any lead connected to the same GCI commander

Parameters
aTrackThe track of interest.

References CommanderProcessor(), SubsTargeting(), Targeting(), and WsfRIPRProcessor().

◆ PeersWeaponsActive()

int WsfRIPRProcessor::PeersWeaponsActive ( const WsfTrack & aTrack)

Return the count of the number of weapons that are active against the specified track. Includes all AIAI agents on same flight and any lead connected to the same GCI commander

Parameters
aTrackThe track of interest.

References CommanderProcessor(), SubsWeaponsActive(), WeaponsActive(), and WsfRIPRProcessor().

◆ ProcessInput()

bool WsfRIPRProcessor::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
aInputa 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 WsfProcessor.

References WsfUplinkProcessor::AddUplinkPath(), WsfPlatformPart::GetPlatform(), WsfUplinkProcessor::GetUplinkProcessor(), mBiddingBlocks, WsfScriptProcessor::mContextPtr, mDesiredJobChannels, mJobBoardCommInput, mJobBoardPtr, mJobTypeChannels, platformPtr, WsfScriptProcessor::ProcessInput(), SetJobPassThrough(), and WsfUplinkProcessor::SetMaxUplinkCount().

◆ ProcessMessage()

bool WsfRIPRProcessor::ProcessMessage ( double aSimTime,
const WsfMessage & aMessage )
overridevirtual

Process a received message.

Parameters
aSimTimeThe current simulation time.
aMessageThe message that is being sent.
Returns
'true' if the message was processed or 'false' if not.
Note
A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References WsfRIPRJob::BidJob(), WsfPlatformPart::DebugEnabled(), WsfAuxDataEnabled::GetAuxDataConst(), WsfRIPRJobBoard::GetJobById(), WsfPlatformPart::GetPlatform(), WsfMessage::GetSubType(), WsfMessage::GetType(), WsfTrackMessage::GetTypeId(), WsfUplinkProcessor::GetUplinkProcessor(), WsfUplinkProcessor::HasUplinkProcessor(), JobBoard(), JobChannelByProcId(), platformPtr, WsfScriptProcessor::ProcessMessage(), WsfUplinkProcessor::ProcessMessage(), SetBufferedJobForChannel(), WsfRIPRJob::SetProgress(), and WsfRIPRJob::UnbidJob().

Referenced by ReceiveMessage().

◆ QueryBid()

◆ QuerySubordinatesMaxBid()

double WsfRIPRProcessor::QuerySubordinatesMaxBid ( WsfRIPRJob & aJob,
bool expandPassThroughAgents = true )

◆ ReceiveMessage()

bool WsfRIPRProcessor::ReceiveMessage ( double aSimTime,
const WsfMessage & aMessage )
overridevirtual

Receive a message from another platform part (system). The default implementation simply calls ProcessMessage to process the received message.

Parameters
aSimTimeThe current simulation time.
aMessageThe message that is being sent.
Returns
'true' if the message was received or 'false' if not.
Note
A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References WsfAuxDataEnabled::GetAuxDataConst(), wsf::comm::NetworkManager::GetComm(), WsfSimulation::GetCommNetworkManager(), WsfMessage::GetDstAddr(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfMessage::GetType(), and ProcessMessage().

◆ RegisterScriptBiddingBlock()

bool WsfRIPRProcessor::RegisterScriptBiddingBlock ( std::string aJobType,
WsfScriptContext * aContextPtr,
UtScript * aScriptPtr )
virtual

References mQueryBidTypeMap.

Referenced by Initialize().

◆ SendMessageJobAward()

◆ SetBidWindowOpen()

void WsfRIPRProcessor::SetBidWindowOpen ( bool aOpen)

References mJobBoardPtr.

◆ SetBufferedJobForChannel()

void WsfRIPRProcessor::SetBufferedJobForChannel ( int aChannelIndex,
int aJob )
inline

References mBufferedJobs.

Referenced by ProcessMessage(), and SetNumJobChannels().

◆ SetJobBoardComm()

void WsfRIPRProcessor::SetJobBoardComm ( wsf::comm::Comm * aCommPtr)
inline

References mJobBoardCommPtr.

Referenced by Initialize().

◆ SetJobPassThrough()

void WsfRIPRProcessor::SetJobPassThrough ( bool aJobPassThrough)

References mJobBoardPtr, and mJobPassThrough.

Referenced by ProcessInput().

◆ SetJobStickiness()

void WsfRIPRProcessor::SetJobStickiness ( double aStickiness)

References mJobBoardPtr.

◆ SetJobWindowOpen()

void WsfRIPRProcessor::SetJobWindowOpen ( bool aOpen)

References mJobBoardPtr.

◆ SetNumJobChannels()

◆ SetTargetByName()

bool WsfRIPRProcessor::SetTargetByName ( std::string aTargetName)

◆ SetTargetByPlatform()

bool WsfRIPRProcessor::SetTargetByPlatform ( WsfPlatform * aPlatformPtr)

◆ SetTargetByPlatformId()

void WsfRIPRProcessor::SetTargetByPlatformId ( size_t aTargetId)

◆ SetTargetByTrack()

bool WsfRIPRProcessor::SetTargetByTrack ( WsfTrack * aTargetTrackPtr)

◆ StartUplinking() [1/2]

◆ StartUplinking() [2/2]

◆ StopUplinking() [1/2]

◆ StopUplinking() [2/2]

bool WsfRIPRProcessor::StopUplinking ( WsfPlatform * receiverPtr)

◆ SubordinatePlatforms() [1/2]

std::vector< WsfPlatform * > WsfRIPRProcessor::SubordinatePlatforms ( )

◆ SubordinatePlatforms() [2/2]

◆ SubordinateProcessors() [1/2]

std::vector< WsfRIPRProcessor * > WsfRIPRProcessor::SubordinateProcessors ( )

◆ SubordinateProcessors() [2/2]

◆ Subordinates()

◆ SubsTargeting()

int WsfRIPRProcessor::SubsTargeting ( const WsfTrack * aTrackPtr,
const WsfPlatform * aExcludePlatform = nullptr )

◆ SubsWeaponsActive()

int WsfRIPRProcessor::SubsWeaponsActive ( const WsfTrack * aTrackPtr,
const WsfPlatform * aExcludePlatform = nullptr )

◆ Targeting()

int WsfRIPRProcessor::Targeting ( const WsfTrack * aTrackPtr)

◆ TargetName()

std::string WsfRIPRProcessor::TargetName ( )

◆ TargetPlatform()

WsfPlatform * WsfRIPRProcessor::TargetPlatform ( )

◆ TargetPlatformId()

size_t WsfRIPRProcessor::TargetPlatformId ( )

References mTargetPlatformIndex.

Referenced by TargetPlatform(), and TargetTrack().

◆ TargetTrack()

◆ UnregisterScriptBiddingBlock()

bool WsfRIPRProcessor::UnregisterScriptBiddingBlock ( std::string aJobType)
virtual

References mQueryBidTypeMap.

◆ Update()

void WsfRIPRProcessor::Update ( double aSimTime)
overridevirtual

Update the state of the processor. This method should perform any actions that are necessary so that the system reflects its condition at the supplied time.

Parameters
aSimTimeThe current simulation time.

Reimplemented from WsfProcessor.

References WsfScriptProcessor::Update().

◆ UplinkCapable()

◆ UplinkWeaponPlatform()

WsfPlatform * WsfRIPRProcessor::UplinkWeaponPlatform ( unsigned int aIndex)

Return the weapon platform at aIndex in the list of the weapons currently being uplinked to.

References WsfPlatformPart::GetPlatform(), WsfUplinkProcessor::GetUplinkProcessor(), WsfUplinkProcessor::HasUplinkProcessor(), platformPtr, and WsfUplinkProcessor::UplinkWeaponPlatform().

◆ ValidJobTypeChannel()

bool WsfRIPRProcessor::ValidJobTypeChannel ( std::string aJobType,
unsigned int aChannelIndex )

◆ WallClock()

double WsfRIPRProcessor::WallClock ( )

References mRiprWallClock.

◆ WeaponFired()

◆ WeaponHit()

void WsfRIPRProcessor::WeaponHit ( double aSimTime,
const WsfWeaponEngagement * aEngagementPtr,
WsfPlatform * aTargetPlatformPtr )

A simulation observer to handle weapon hit events.

Parameters
aSimTimeThe current simulation time.
aEngagementPtrA pointer to the weapon engagement data.
aTargetPlatformPtrA pointer to the targeted platform

References FindWeaponStatus(), WsfWeaponEngagement::GetFiringPlatformIndex(), WsfWeaponEngagement::GetTargetTrackId(), WsfWeaponEngagement::GetWeaponSystemName(), WsfTrackId::IsNull(), WsfRIPRProcessor::WeaponStatus::mRoundsHit, WsfRIPRProcessor::WeaponStatus::mTimeWeaponLastHit, and mWeaponStatusList.

Referenced by Initialize().

◆ WeaponMissed()

void WsfRIPRProcessor::WeaponMissed ( double aSimTime,
const WsfWeaponEngagement * aEngagementPtr,
WsfPlatform * aTargetPlatformPtr )

A simulation observer to handle weapon miss events.

Parameters
aSimTimeThe current simulation time.
aEngagementPtrA pointer to the weapon engagement data.
aTargetPlatformPtrA pointer to the targeted platform

References FindWeaponStatus(), WsfWeaponEngagement::GetFiringPlatformIndex(), WsfWeaponEngagement::GetTargetTrackId(), WsfWeaponEngagement::GetWeaponSystemName(), WsfTrackId::IsNull(), WsfRIPRProcessor::WeaponStatus::mRoundsMissed, WsfRIPRProcessor::WeaponStatus::mTimeWeaponLastMissed, and mWeaponStatusList.

Referenced by Initialize().

◆ WeaponsActive() [1/2]

int WsfRIPRProcessor::WeaponsActive ( )

Return the count of the number of weapons that are active.

References mActiveWeaponList.

Referenced by PeersWeaponsActive().

◆ WeaponsActive() [2/2]

int WsfRIPRProcessor::WeaponsActive ( const WsfTrack & aTrack)

Return the count of the number of weapons that are active against the specified track.

Parameters
aTrackThe track of interest.

References WsfTrack::GetTargetIndex(), mActiveWeaponList, and targetIndex().

Referenced by SubsWeaponsActive().

◆ WeaponsActiveOfType()

int WsfRIPRProcessor::WeaponsActiveOfType ( const WsfWeapon & aWeapon)

Return the count of the number of weapons of type aWeapon that are active.

Parameters
aWeaponThe weapon type of interest.

References WsfObject::GetNameId(), and mWeaponStatusList.

◆ WeaponsIncoming()

std::vector< WsfPlatform * > WsfRIPRProcessor::WeaponsIncoming ( )

◆ WeaponTerminated()

◆ WeaponUplinkCount()

Member Data Documentation

◆ mActiveWeaponList

◆ mBiddingBlocks

std::vector<std::pair<std::string, UtScript*> > WsfRIPRProcessor::mBiddingBlocks
protected

◆ mBiddingHijacked

bool WsfRIPRProcessor::mBiddingHijacked
protected

If true, this processor cannot bid from script calls.

Referenced by BiddingHijacked(), BiddingHijacked(), WsfRIPRProcessor(), WsfRIPRProcessor(), WsfRIPRProcessor(), and WsfRIPRProcessor().

◆ mBufferedJobs

ripr::RIPRChannelJobMap WsfRIPRProcessor::mBufferedJobs
protected

map of which job id each channel id thinks it should currently be doing, indexed by job id

Referenced by BufferedJobForChannel(), SetBufferedJobForChannel(), WsfRIPRProcessor(), and ~WsfRIPRProcessor().

◆ mCallbacks

UtCallbackHolder WsfRIPRProcessor::mCallbacks

Referenced by Initialize().

◆ mDesiredJobChannels

unsigned int WsfRIPRProcessor::mDesiredJobChannels
protected

◆ mJobBoardCommInput

WsfStringId WsfRIPRProcessor::mJobBoardCommInput
protected

nameid of the WsfComm object to stick in mJobBoardComm during initialize; read during process input

Referenced by Initialize(), ProcessInput(), WsfRIPRProcessor(), WsfRIPRProcessor(), WsfRIPRProcessor(), and WsfRIPRProcessor().

◆ mJobBoardCommPtr

wsf::comm::Comm* WsfRIPRProcessor::mJobBoardCommPtr
protected

pointer to the WsfComm object to be used by mJobBoard

Referenced by JobBoardComm(), SetJobBoardComm(), WsfRIPRProcessor(), WsfRIPRProcessor(), WsfRIPRProcessor(), and WsfRIPRProcessor().

◆ mJobBoardPtr

◆ mJobChannelIds

◆ mJobPassThrough

bool WsfRIPRProcessor::mJobPassThrough
protected

◆ mJobTypeChannels

◆ mManagerPtr

◆ mQueryBidTypeMap

QueryBidMapType WsfRIPRProcessor::mQueryBidTypeMap
protected

◆ mRiprWallClock

UtWallClock WsfRIPRProcessor::mRiprWallClock
protected

Referenced by WallClock().

◆ mTargetPlatformIndex

◆ mWeaponStatusList


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