M_Mount::NotifyRateScaled Struct Reference

Public Member Functions
	NotifyRateScaled ()
	NotifyRateScaled (std::string const &InputSourceClientId, M_Mount::ScaledRateOptionalType const &ScaledRate)

Public Attributes
std::string	InputSourceClientId
	The client name of the calling instance associated with the scaled rate. More...
M_Mount::ScaledRateOptionalType	ScaledRate

Detailed Description

Provides the Mount with normed rate of movement. This sets the rate of movement normed to the maximum possible rate of the Mount. A value of 0 stops the Mount from moving. A value of 1 or -1 moves the Mount at the maximum rate. A negative value moves the Mount in the opposite direction.

Note: This is implemented as a notify call in order to always contain the latest value from a client. This can then correspond to an output report from a joystick.

Note: This operation shall be called only if the InputSourceClientId matches with the MountStatusType.InputSourceClientId of ReportMountStatus().

Constructor & Destructor Documentation

NotifyRateScaled() [1/2]

M_Mount::NotifyRateScaled::NotifyRateScaled

(

)

NotifyRateScaled() [2/2]

M_Mount::NotifyRateScaled::NotifyRateScaled	(	std::string const &	InputSourceClientId,
		M_Mount::ScaledRateOptionalType const &	ScaledRate
	)

Member Data Documentation

InputSourceClientId

std::string M_Mount::NotifyRateScaled::InputSourceClientId

The client name of the calling instance associated with the scaled rate.

ScaledRate

M_Mount::ScaledRateOptionalType M_Mount::NotifyRateScaled::ScaledRate

Rate of movement normed to the maximum possible rate of the Mount. Note: Not present indicates no rate (similar to setting a rate of 0)