#include "legato.h"
#include "taf_locGnss_common.h"

Macros
#define	IFGEN_TAF_LOCPOS_PROTOCOL_ID "7524055dcdb06eb2aa3fcec77b6f8445"

#define	IFGEN_TAF_LOCPOS_MSG_SIZE 32

#define	TAF_LOCPOS_TAF_LOCPOS_MAX_OBJ 1

Typedefs
typedef struct taf_locPos_Sample *	taf_locPos_SampleRef_t

typedef struct taf_locPos_MovementHandler *	taf_locPos_MovementHandlerRef_t

typedef void(*	taf_locPos_MovementHandlerFunc_t) (taf_locPos_SampleRef_t positionSampleRef, void *contextPtr)

Enumerations
enum	taf_locPos_Resolution_t { TAF_LOCPOS_RES_METER = 0, TAF_LOCPOS_RES_DECIMETER = 1, TAF_LOCPOS_RES_CENTIMETER = 2, TAF_LOCPOS_RES_MILLIMETER = 3, TAF_LOCPOS_RES_UNKNOWN = 4 }

Functions
LE_SHARED bool	ifgen_taf_locPos_HasLocalBinding (void)

LE_SHARED void	ifgen_taf_locPos_InitCommonData (void)

LE_SHARED void	ifgen_taf_locPos_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)

LE_SHARED le_result_t	ifgen_taf_locPos_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)

LE_SHARED taf_locPos_MovementHandlerRef_t	ifgen_taf_locPos_AddMovementHandler (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t horizontalMagnitude, uint32_t verticalMagnitude, taf_locPos_MovementHandlerFunc_t handlerPtr, void *contextPtr)

LE_SHARED void	ifgen_taf_locPos_RemoveMovementHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_MovementHandlerRef_t handlerRef)

LE_SHARED le_result_t	ifgen_taf_locPos_Get2DLocation (le_msg_SessionRef_t _ifgen_sessionRef, int32_t latitudePtr, int32_t longitudePtr, int32_t *hAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_GetDate (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t yearPtr, uint16_t monthPtr, uint16_t *dayPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_GetFixState (le_msg_SessionRef_t _ifgen_sessionRef, taf_locGnss_FixState_t *statePtr)

LE_SHARED le_result_t	ifgen_taf_locPos_GetMotion (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t hSpeedPtr, uint32_t hSpeedAccuracyPtr, int32_t vSpeedPtr, int32_t vSpeedAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_GetDirection (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t directionPtr, uint32_t directionAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_GetTime (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t hoursPtr, uint16_t minutesPtr, uint16_t secondsPtr, uint16_t millisecondsPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_SetAcquisitionRate (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t acquisitionRate)

LE_SHARED uint32_t	ifgen_taf_locPos_GetAcquisitionRate (le_msg_SessionRef_t _ifgen_sessionRef)

LE_SHARED void	ifgen_taf_locPos_sample_Release (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef)

LE_SHARED le_result_t	ifgen_taf_locPos_Get3DLocation (le_msg_SessionRef_t _ifgen_sessionRef, int32_t latitudePtr, int32_t longitudePtr, int32_t hAccuracyPtr, int32_t altitudePtr, int32_t *vAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_Get2DLocation (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, int32_t latitudePtr, int32_t longitudePtr, int32_t *horizontalAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetAltitude (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, int32_t altitudePtr, int32_t altitudeAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetTime (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, uint16_t hoursPtr, uint16_t minutesPtr, uint16_t secondsPtr, uint16_t millisecondsPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetHorizontalSpeed (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, uint32_t hSpeedPtr, uint32_t hSpeedAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetDirection (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, uint32_t directionPtr, uint32_t directionAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetVerticalSpeed (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, int32_t vspeedPtr, int32_t vspeedAccuracyPtr)

LE_SHARED le_result_t	ifgen_taf_locPos_SetDistanceResolution (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_Resolution_t resolution)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetFixState (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, taf_locGnss_FixState_t *statePtr)

LE_SHARED le_result_t	ifgen_taf_locPos_sample_GetDate (le_msg_SessionRef_t _ifgen_sessionRef, taf_locPos_SampleRef_t positionSampleRef, uint16_t yearPtr, uint16_t monthPtr, uint16_t *dayPtr)

Macro Definition Documentation

◆ IFGEN_TAF_LOCPOS_PROTOCOL_ID

#define IFGEN_TAF_LOCPOS_PROTOCOL_ID "7524055dcdb06eb2aa3fcec77b6f8445"

◆ IFGEN_TAF_LOCPOS_MSG_SIZE

#define IFGEN_TAF_LOCPOS_MSG_SIZE 32

◆ TAF_LOCPOS_TAF_LOCPOS_MAX_OBJ

#define TAF_LOCPOS_TAF_LOCPOS_MAX_OBJ 1

Typedef Documentation

◆ taf_locPos_SampleRef_t

typedef struct taf_locPos_Sample* taf_locPos_SampleRef_t

Position sample reference type.

◆ taf_locPos_MovementHandlerRef_t

typedef struct taf_locPos_MovementHandler* taf_locPos_MovementHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_locPos_Movement'

◆ taf_locPos_MovementHandlerFunc_t

typedef void(* taf_locPos_MovementHandlerFunc_t) (taf_locPos_SampleRef_t positionSampleRef, void *contextPtr)

Handler for movement changes that returns the reference of a reported position sample.

Enumeration Type Documentation

◆ taf_locPos_Resolution_t

enum taf_locPos_Resolution_t

Resolution values.

Enumerator
TAF_LOCPOS_RES_METER	Meter resolution.
TAF_LOCPOS_RES_DECIMETER	Decimeter resolution.
TAF_LOCPOS_RES_CENTIMETER	Centimeter resolution.
TAF_LOCPOS_RES_MILLIMETER	Millimeter resolution.
TAF_LOCPOS_RES_UNKNOWN	Unknown resolution.

Function Documentation

◆ ifgen_taf_locPos_HasLocalBinding()

LE_SHARED bool ifgen_taf_locPos_HasLocalBinding ( void )

Get if this client bound locally.

◆ ifgen_taf_locPos_InitCommonData()

LE_SHARED void ifgen_taf_locPos_InitCommonData ( void )

Init data that is common across all threads

◆ ifgen_taf_locPos_CleanupCommonData()

LE_SHARED void ifgen_taf_locPos_CleanupCommonData ( le_msg_SessionRef_t _ifgen_sessionRef )

Cleanup the data of a session

◆ ifgen_taf_locPos_OpenSession()

LE_SHARED le_result_t ifgen_taf_locPos_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

◆ ifgen_taf_locPos_AddMovementHandler()

LE_SHARED taf_locPos_MovementHandlerRef_t ifgen_taf_locPos_AddMovementHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint32_t	horizontalMagnitude,
		uint32_t	verticalMagnitude,
		taf_locPos_MovementHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_locPos_Movement'

This event provides information on movement changes.

Parameters

[in]	horizontalMagnitude	Horizontal magnitude in meters.
[in]	verticalMagnitude	Vertical magnitude in meters.
[in]	handlerPtr
[in]	contextPtr

◆ ifgen_taf_locPos_RemoveMovementHandler()

LE_SHARED void ifgen_taf_locPos_RemoveMovementHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_MovementHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_locPos_Movement'

Parameters

[in] handlerRef

◆ ifgen_taf_locPos_Get2DLocation()

LE_SHARED le_result_t ifgen_taf_locPos_Get2DLocation	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	hAccuracyPtr
	)

Gets the 2D location data (latitude, longitude, horizontal accuracy).

Returns

LE_FAULT Failed to get the 2D location data.
LE_OUT_OF_RANGE One, or more, retrieved parameters is invalid.
LE_OK Succeeded.

Note: latitudePtr, longitudePtr, hAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	latitudePtr	WGS84 latitude in degrees.
[out]	longitudePtr	WGS84 longitude in degrees.
[out]	hAccuracyPtr	Horizontal accuracy in meters by default.

◆ ifgen_taf_locPos_GetDate()

LE_SHARED le_result_t ifgen_taf_locPos_GetDate	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint16_t *	yearPtr,
		uint16_t *	monthPtr,
		uint16_t *	dayPtr
	)

Gets the date of the last updated location.

Returns

LE_FAULT Failed to get the date.
LE_OUT_OF_RANGE The retrieved date is invalid.
LE_OK Succeeded.

Note: Currently the API implementation is in progress.

Parameters

[out]	yearPtr	UTC Year A.D., e.g. 2014.
[out]	monthPtr	UTC Month into the year; range is 1 to 12.
[out]	dayPtr	UTC Days into the month; range is 1 to 31.

◆ ifgen_taf_locPos_GetFixState()

LE_SHARED le_result_t ifgen_taf_locPos_GetFixState	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locGnss_FixState_t *	statePtr
	)

Gets the position fix state.

Returns

LE_FAULT Failed to get the position fix state.
LE_OK Succeeded.

Note: In case the function fails to get the position fix state, a fatal error occurs, the function will not return.

Parameters

[out] statePtr Position fix state.

◆ ifgen_taf_locPos_GetMotion()

LE_SHARED le_result_t ifgen_taf_locPos_GetMotion	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint32_t *	hSpeedPtr,
		uint32_t *	hSpeedAccuracyPtr,
		int32_t *	vSpeedPtr,
		int32_t *	vSpeedAccuracyPtr
	)

Gets the motion data (horizontal speed, horizontal speed accuracy, vertical speed, and vertical speed accuracy).

Returns

LE_FAULT Failed to get the motion data.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid (set to INT32_MAX, UINT32_MAX).
LE_OK Succeeded.

Note: hSpeedPtr, hSpeedAccuracyPtr, vSpeedPtr, and vSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	hSpeedPtr	Horizontal speed in m/sec.
[out]	hSpeedAccuracyPtr	Horizontal speed accuracy in m/sec.
[out]	vSpeedPtr	Vertical speed in m/sec.
[out]	vSpeedAccuracyPtr	Vertical speed accuracy in m/sec.

◆ ifgen_taf_locPos_GetDirection()

LE_SHARED le_result_t ifgen_taf_locPos_GetDirection	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint32_t *	directionPtr,
		uint32_t *	directionAccuracyPtr
	)

Gets the position sample's direction. Direction of movement is the direction that the vehicle or person is actually moving.

Returns

LE_FAULT Failed to get the direction indication.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
LE_OK Succeeded.

Note: Direction is given in degrees. Direction ranges from 0 to 359 degrees, where 0 is true North degree.; directionPtr and directionAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	directionPtr	Direction indication in degrees; range is 0 to 359.
[out]	directionAccuracyPtr	Direction's accuracy estimation in degrees.

◆ ifgen_taf_locPos_GetTime()

LE_SHARED le_result_t ifgen_taf_locPos_GetTime	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint16_t *	hoursPtr,
		uint16_t *	minutesPtr,
		uint16_t *	secondsPtr,
		uint16_t *	millisecondsPtr
	)

Gets the position sample's time.

Returns

LE_FAULT Failed to get the time.
LE_OUT_OF_RANGE The retrieved time is invalid.
LE_OK Succeeded.

Parameters

[out]	hoursPtr	UTC Hours of the day; range is 0 to 23.
[out]	minutesPtr	UTC Minutes of the hour; range is 0 to 59.
[out]	secondsPtr	UTC Seconds of the minute; range is 0 to 59.
[out]	millisecondsPtr	UTC Milliseconds of the second; range is 0 to 999.

◆ ifgen_taf_locPos_SetAcquisitionRate()

LE_SHARED le_result_t ifgen_taf_locPos_SetAcquisitionRate	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint32_t	acquisitionRate
	)

Sets the acquisition rate.

Returns

LE_OUT_OF_RANGE Acquisition rate is invalid.
LE_OK Succeeded.

Parameters

[in] acquisitionRate Acquisition Rate in milliseconds.

◆ ifgen_taf_locPos_GetAcquisitionRate()

LE_SHARED uint32_t ifgen_taf_locPos_GetAcquisitionRate ( le_msg_SessionRef_t _ifgen_sessionRef )

Retrieves the acquisition rate in milliseconds.

Returns: Acquisition rate in milliseconds.

◆ ifgen_taf_locPos_sample_Release()

LE_SHARED void ifgen_taf_locPos_sample_Release	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef
	)

Releases the position sample.

Note: If the caller is passing an invalid position reference to this function, it is a fatal error and the function will not return.

Parameters

[in] positionSampleRef Position sample reference.

◆ ifgen_taf_locPos_Get3DLocation()

LE_SHARED le_result_t ifgen_taf_locPos_Get3DLocation	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	hAccuracyPtr,
		int32_t *	altitudePtr,
		int32_t *	vAccuracyPtr
	)

Gets the 3D location data (latitude, longitude, altitude, horizontal accuracy, vertical accuracy)

Returns

LE_FAULT Failed to get the 3D location data.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
LE_OK Succeeded.

Note: latitudePtr, longitudePtr,hAccuracyPtr, altitudePtr, and vAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	latitudePtr	WGS84 Latitude in degrees.
[out]	longitudePtr	WGS84 Longitude in degrees.
[out]	hAccuracyPtr	Horizontal accuracy in meters by default.
[out]	altitudePtr	Altitude above mean sea level in meters by default.
[out]	vAccuracyPtr	Vertical accuracy in meters by default.

◆ ifgen_taf_locPos_sample_Get2DLocation()

LE_SHARED le_result_t ifgen_taf_locPos_sample_Get2DLocation	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	horizontalAccuracyPtr
	)

Gets the position sample's 2D location (latitude, longitude, horizontal accuracy)

Returns

LE_FAULT Failed to find the positionSample.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
LE_OK Suceeded.

Note: If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.; latitudePtr, longitudePtr, and horizontalAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	latitudePtr	WGS84 latitude in degrees.
[out]	longitudePtr	WGS84 longitude in degrees.
[out]	horizontalAccuracyPtr	Horizontal accuracy in meters by default.

◆ ifgen_taf_locPos_sample_GetAltitude()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetAltitude	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		int32_t *	altitudePtr,
		int32_t *	altitudeAccuracyPtr
	)

Gets the position sample's altitude.

Returns

LE_FAULT Failed to find the positionSample.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
LE_OK Suceeded.

Note: If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.; altitudePtr and altitudeAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	altitudePtr	Altitude above mean sea level in meters by default.
[out]	altitudeAccuracyPtr	Vertical accuracy in meters by default.

◆ ifgen_taf_locPos_sample_GetTime()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetTime	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		uint16_t *	hoursPtr,
		uint16_t *	minutesPtr,
		uint16_t *	secondsPtr,
		uint16_t *	millisecondsPtr
	)

Gets the position sample's time.

Returns

LE_FAULT Failed to get the time.
LE_OUT_OF_RANGE The retrieved time is invalid.
LE_OK Succeeded.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	hoursPtr	UTC hours of the day; range is 0 to 23.
[out]	minutesPtr	UTC minutes of the hour; range is 0 to 59.
[out]	secondsPtr	UTC seconds of the minute; range is 0 to 59.
[out]	millisecondsPtr	UTC milliseconds of the second; range is 0 to 999.

◆ ifgen_taf_locPos_sample_GetHorizontalSpeed()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetHorizontalSpeed	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		uint32_t *	hSpeedPtr,
		uint32_t *	hSpeedAccuracyPtr
	)

Gets the position sample's horizontal speed.

Returns

LE_FAULT Failed to find the positionSample.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
LE_OK Suceeded.

Note: If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.; hSpeedPtr and hSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	hSpeedPtr	The horizontal speed in m/sec.
[out]	hSpeedAccuracyPtr	The horizontal accuracy in m/sec.

◆ ifgen_taf_locPos_sample_GetDirection()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetDirection	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		uint32_t *	directionPtr,
		uint32_t *	directionAccuracyPtr
	)

Get the position sample's direction

Returns

LE_FAULT Failed to find the positionSample.
LE_OUT_OF_RANGE One of the retrieved parameter is invalid.
LE_OK Suceeded.

Note: Direction is given in degrees. Direction ranges from 0 to 359 degrees, where 0 is true North.; If the caller passed an invalid position reference to this function, it is a fatal error and the function will not return.; directionPtr and directionAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	directionPtr	Direction indication in degrees.
[out]	directionAccuracyPtr	Direction's accuracy estimation in degrees.

◆ ifgen_taf_locPos_sample_GetVerticalSpeed()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetVerticalSpeed	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		int32_t *	vspeedPtr,
		int32_t *	vspeedAccuracyPtr
	)

Gets the position sample's vertical speed.

Returns

LE_FAULT Failed to find the positionSample.
LE_OUT_OF_RANGE One, or more, of the retrieved parameters is not valid.
LE_OK Suceeded.

Note: If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.; vSpeedPtr and vSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample reference
[out]	vspeedPtr	The vertical speed in m/sec.
[out]	vspeedAccuracyPtr	The vertical speed's accuracy in m/sec.

◆ ifgen_taf_locPos_SetDistanceResolution()

LE_SHARED le_result_t ifgen_taf_locPos_SetDistanceResolution	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_Resolution_t	resolution
	)

Sets the resolution for the positioning distance values.

Returns

LE_OK Suceeded.
LE_BAD_PARAMETER Invalid parameter provided.

Note: The positioning distance values are: the altitude above sea level, the horizontal position accuracy and the vertical position accuracy. The API sets the same resolution to all distance values. The resolution change request takes effect immediately.

Parameters

[in] resolution Resolution.

◆ ifgen_taf_locPos_sample_GetFixState()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetFixState	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		taf_locGnss_FixState_t *	statePtr
	)

Gets the position sample's fix state.

Returns

LE_FAULT Failed to get the position sample's fix state.
LE_OK Suceeded.

Note: If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	statePtr	Position fix state.

◆ ifgen_taf_locPos_sample_GetDate()

LE_SHARED le_result_t ifgen_taf_locPos_sample_GetDate	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_locPos_SampleRef_t	positionSampleRef,
		uint16_t *	yearPtr,
		uint16_t *	monthPtr,
		uint16_t *	dayPtr
	)

Gets the position sample date.

Returns

LE_FAULT Failed to get the date.
LE_OUT_OF_RANGE The retrieved date is invalid.
LE_OK Suceeded.

Parameters

[in]	positionSampleRef	Position sample reference.
[out]	yearPtr	UTC year
[out]	monthPtr	UTC month of the year; range is 1 to 12.
[out]	dayPtr	UTC day of the month; range is 1 to 31.

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ IFGEN_TAF_LOCPOS_PROTOCOL_ID

◆ IFGEN_TAF_LOCPOS_MSG_SIZE

◆ TAF_LOCPOS_TAF_LOCPOS_MAX_OBJ

Typedef Documentation

◆ taf_locPos_SampleRef_t

◆ taf_locPos_MovementHandlerRef_t

◆ taf_locPos_MovementHandlerFunc_t

Enumeration Type Documentation

◆ taf_locPos_Resolution_t

Function Documentation

◆ ifgen_taf_locPos_HasLocalBinding()

◆ ifgen_taf_locPos_InitCommonData()

◆ ifgen_taf_locPos_CleanupCommonData()

◆ ifgen_taf_locPos_OpenSession()

◆ ifgen_taf_locPos_AddMovementHandler()

◆ ifgen_taf_locPos_RemoveMovementHandler()

◆ ifgen_taf_locPos_Get2DLocation()

◆ ifgen_taf_locPos_GetDate()

◆ ifgen_taf_locPos_GetFixState()

◆ ifgen_taf_locPos_GetMotion()

◆ ifgen_taf_locPos_GetDirection()

◆ ifgen_taf_locPos_GetTime()

◆ ifgen_taf_locPos_SetAcquisitionRate()

◆ ifgen_taf_locPos_GetAcquisitionRate()

◆ ifgen_taf_locPos_sample_Release()

◆ ifgen_taf_locPos_Get3DLocation()

◆ ifgen_taf_locPos_sample_Get2DLocation()

◆ ifgen_taf_locPos_sample_GetAltitude()

◆ ifgen_taf_locPos_sample_GetTime()

◆ ifgen_taf_locPos_sample_GetHorizontalSpeed()

◆ ifgen_taf_locPos_sample_GetDirection()

◆ ifgen_taf_locPos_sample_GetVerticalSpeed()

◆ ifgen_taf_locPos_SetDistanceResolution()

◆ ifgen_taf_locPos_sample_GetFixState()

◆ ifgen_taf_locPos_sample_GetDate()