WsfXIO_TrackRequest Class Reference

#include <WsfXIO_TrackRequest.hpp>

Inheritance diagram for WsfXIO_TrackRequest:

Collaboration diagram for WsfXIO_TrackRequest:

Public Member Functions
	WsfXIO_TrackRequest (int aRemotePlatformIndex, WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
void	SetSensorName (WsfStringId aSensorName)
WsfStringId	GetSensorName () const
void	EnableSendInitialTracks ()
void	SetRequiredData (int aRequiredData)
virtual void	Handle (const WsfXIO_RawTrackPkt &aPkt)
virtual void	Handle (const WsfXIO_LocalTrackPkt &aPkt)
virtual void	Handle (const WsfXIO_TrackDropPkt &aPkt)
int	GetPlatformIndex () const
	Returns the index of platform whose tracks this object is requesting.
void	SetUpdateInterval (double aUpdateInterval, bool aRealTime)
void	HandleResponse (WsfXIO_ResponsePkt &aPkt) override
bool	IsGlobalRequest () const
	Returns 'true' if this request will be serviced with undirected responses. Used internally.
Public Member Functions inherited from WsfXIO_Request
	WsfXIO_Request (WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
void	SendRequest (WsfXIO_RequestDataPkt &aPkt)
	Sends the request to the remote application.
WsfXIO_Connection *	GetConnection () const
	Returns the connection to the application from which data is requested.
bool	IsReliable () const
	Returns 'true' if data for this request is to be sent reliably.
int	GetRequestId () const
	Returns the request's locally unique ID.
void	SetRequestManager (WsfXIO_RequestManager *aRequestManagerPtr)
	Sets the owner of this request.
void	SendResponse (WsfXIO_ResponsePkt &aPkt)

Protected Member Functions
void	Initialized () override
Protected Member Functions inherited from WsfXIO_Request
virtual	~WsfXIO_Request ()
void	SetRequestId (unsigned int aRequestId)
void	SetRemotelyDestroyed ()
bool	IsRemotelyDestroyed () const
void	SetIsReliable (bool aIsReliable)

Protected Attributes
int	mRemotePlatformIndex
int	mRequiredData
bool	mSendInitialTracks
WsfStringId	mSensorNameId
double	mUpdateInterval
bool	mRealTime

Detailed Description

Represents a request for track information. May be subclassed to handle received tracks

Constructor & Destructor Documentation

WsfXIO_TrackRequest()

WsfXIO_TrackRequest::WsfXIO_TrackRequest	(	int	aRemotePlatformIndex,
		WsfXIO_Connection *	aConnectionPtr,
		bool	aIsReliable = true )

Construct a WsfXIO_TrackRequest aRemotePlatformIndex is the index of the platform in the simulation that is receiving the request

References mRealTime, mRemotePlatformIndex, mRequiredData, mSendInitialTracks, mUpdateInterval, and WsfXIO_Request::WsfXIO_Request().

Member Function Documentation

EnableSendInitialTracks()

void WsfXIO_TrackRequest::EnableSendInitialTracks ( )

inline

Specifies that tracks already in the track manager will be sent upon accepted request

References mSendInitialTracks.

GetPlatformIndex()

int WsfXIO_TrackRequest::GetPlatformIndex ( ) const

inline

Returns the index of platform whose tracks this object is requesting.

References mRemotePlatformIndex.

Referenced by WsfXIO_TrackRequestManager::AddRequest(), and WsfXIO_TrackRequestManager::RequestCancelled().

GetSensorName()

WsfStringId WsfXIO_TrackRequest::GetSensorName ( ) const

inline

References mSensorNameId.

Handle() [1/3]

virtual void WsfXIO_TrackRequest::Handle ( const WsfXIO_LocalTrackPkt & aPkt )

inlinevirtual

Handle() [2/3]

virtual void WsfXIO_TrackRequest::Handle ( const WsfXIO_RawTrackPkt & aPkt )

inlinevirtual

Handle() is called when a messages sent as a response to this request are received.

Referenced by WsfXIO_TrackRequestManager::ForwardPacket(), and HandleResponse().

Handle() [3/3]

virtual void WsfXIO_TrackRequest::Handle ( const WsfXIO_TrackDropPkt & aPkt )

inlinevirtual

HandleResponse()

void WsfXIO_TrackRequest::HandleResponse ( WsfXIO_ResponsePkt & aPkt )

overridevirtual

Reimplemented from WsfXIO_Request.

References WsfXIO_Packet::cPACKET_ID, and Handle().

Initialized()

void WsfXIO_TrackRequest::Initialized ( )

overrideprotectedvirtual

Called from the WsfXIO_RequestManager indicating that the request message is ready to be sent SendRequest() should be done from Initialized()

Implements WsfXIO_Request.

References WsfXIO_RequestTracksPkt::mPlatformIndex, mRealTime, WsfXIO_RequestTracksPkt::mRealtimeInterval, mRemotePlatformIndex, WsfXIO_RequestTracksPkt::mRequiredData, mRequiredData, WsfXIO_RequestTracksPkt::mSendInitialTracks, mSendInitialTracks, WsfXIO_RequestTracksPkt::mSensorNameId, mSensorNameId, WsfXIO_RequestTracksPkt::mUpdateInterval, mUpdateInterval, and WsfXIO_Request::SendRequest().

IsGlobalRequest()

bool WsfXIO_TrackRequest::IsGlobalRequest ( ) const

inline

Returns 'true' if this request will be serviced with undirected responses. Used internally.

References mSensorNameId, and mUpdateInterval.

Referenced by WsfXIO_TrackRequestManager::AddRequest(), and WsfXIO_TrackRequestManager::RequestCancelled().

SetRequiredData()

void WsfXIO_TrackRequest::SetRequiredData ( int aRequiredData )

inline

Specifies what kind of track data is required to be sent

Parameters

aRequiredData

A combination of flags in WsfXIO_RequestTracksPkt::TrackData

References mRequiredData.

SetSensorName()

void WsfXIO_TrackRequest::SetSensorName ( WsfStringId aSensorName )

inline

Sets the sensor name for the track request. Must be used prior to submitting the request. Default is empty.

References mSensorNameId.

SetUpdateInterval()

void WsfXIO_TrackRequest::SetUpdateInterval	(	double	aUpdateInterval,
		bool	aRealTime )

References mRealTime, and mUpdateInterval.

Member Data Documentation

mRealTime

bool WsfXIO_TrackRequest::mRealTime

protected

Referenced by Initialized(), SetUpdateInterval(), and WsfXIO_TrackRequest().

mRemotePlatformIndex

int WsfXIO_TrackRequest::mRemotePlatformIndex

protected

Referenced by GetPlatformIndex(), Initialized(), and WsfXIO_TrackRequest().

mRequiredData

int WsfXIO_TrackRequest::mRequiredData

protected

Referenced by Initialized(), SetRequiredData(), and WsfXIO_TrackRequest().

mSendInitialTracks

bool WsfXIO_TrackRequest::mSendInitialTracks

protected

Referenced by EnableSendInitialTracks(), Initialized(), and WsfXIO_TrackRequest().

mSensorNameId

WsfStringId WsfXIO_TrackRequest::mSensorNameId

protected

Referenced by GetSensorName(), Initialized(), IsGlobalRequest(), and SetSensorName().

mUpdateInterval

double WsfXIO_TrackRequest::mUpdateInterval

protected

Referenced by Initialized(), IsGlobalRequest(), SetUpdateInterval(), and WsfXIO_TrackRequest().

---

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

• WsfXIO_TrackRequest.hpp
• WsfXIO_TrackRequest.cpp