WsfXIO_PlatformPartInfoRequest Class Reference

Request for platform part information. More...

#include <WsfXIO_PlatformInfoService.hpp>

Inheritance diagram for WsfXIO_PlatformPartInfoRequest:

Collaboration diagram for WsfXIO_PlatformPartInfoRequest:

Public Member Functions
	WsfXIO_PlatformPartInfoRequest (int aPlatformIndex, int aPartType, WsfStringId aPartName, WsfXIO_Connection *aConnectionPtr)
void	SetUpdateInterval (double aUpdateInterval, bool aRealTimeInterval=false)
void	Initialized () override
int	GetPlatformIndex () const
WsfStringId	GetPartName () const
Public Member Functions inherited from WsfXIO_Request
	WsfXIO_Request (WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
virtual void	HandleResponse (WsfXIO_ResponsePkt &aPkt)
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 Attributes
int	mPlatformIndex
int	mPartType
WsfStringId	mPartName
double	mUpdateInterval
bool	mRealtimeInterval

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

Detailed Description

Request for platform part information.

Constructor & Destructor Documentation

WsfXIO_PlatformPartInfoRequest()

WsfXIO_PlatformPartInfoRequest::WsfXIO_PlatformPartInfoRequest	(	int	aPlatformIndex,
		int	aPartType,
		WsfStringId	aPartName,
		WsfXIO_Connection *	aConnectionPtr )

References mPartName, mPartType, mPlatformIndex, mRealtimeInterval, mUpdateInterval, and WsfXIO_Request::WsfXIO_Request().

Member Function Documentation

GetPartName()

WsfStringId WsfXIO_PlatformPartInfoRequest::GetPartName ( ) const

inline

References mPartName.

GetPlatformIndex()

int WsfXIO_PlatformPartInfoRequest::GetPlatformIndex ( ) const

inline

References mPlatformIndex.

Initialized()

void WsfXIO_PlatformPartInfoRequest::Initialized ( )

overridevirtual

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 mPartName, WsfXIO_RequestPlatformPartInfoPkt::mPartName, mPartType, WsfXIO_RequestPlatformPartInfoPkt::mPartType, mPlatformIndex, WsfXIO_RequestPlatformPartInfoPkt::mPlatformIndex, mRealtimeInterval, WsfXIO_RequestPlatformPartInfoPkt::mRealtimeInterval, mUpdateInterval, WsfXIO_RequestPlatformPartInfoPkt::mUpdateInterval, and WsfXIO_Request::SendRequest().

SetUpdateInterval()

void WsfXIO_PlatformPartInfoRequest::SetUpdateInterval ( double aUpdateInterval, bool aRealTimeInterval = false )

inline

References mRealtimeInterval, and mUpdateInterval.

Member Data Documentation

mPartName

WsfStringId WsfXIO_PlatformPartInfoRequest::mPartName

protected

Referenced by GetPartName(), Initialized(), and WsfXIO_PlatformPartInfoRequest().

mPartType

int WsfXIO_PlatformPartInfoRequest::mPartType

protected

Referenced by Initialized(), and WsfXIO_PlatformPartInfoRequest().

mPlatformIndex

int WsfXIO_PlatformPartInfoRequest::mPlatformIndex

protected

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

mRealtimeInterval

bool WsfXIO_PlatformPartInfoRequest::mRealtimeInterval

protected

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

mUpdateInterval

double WsfXIO_PlatformPartInfoRequest::mUpdateInterval

protected

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

---

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

• WsfXIO_PlatformInfoService.hpp
• WsfXIO_PlatformInfoService.cpp