MatLabXRK.h

#ifndef SIMPLEH_H
#define SIMPLEH_H

#include "helper.h"

#ifdef  __cplusplus
extern "C" {
#endif


//! Get the compile date of this library
/*!
\return the compile date
*/
EXPORTED_FUNCTION char const* get_library_date();

//! Get the compile time of this library
/*!
\return the compile time
*/
EXPORTED_FUNCTION char const* get_library_time();

//! Open a xrk file
/*!
\param full_path_name full path to the file to be opened, it cannot be a relative path
\return > 0 in case of success the internal index of the file opened, 0 in case the file is opened but can't be parsed, < 0 in case of problems
*/
EXPORTED_FUNCTION int open_file(char const* full_path_name);

//! Close a xrk file
/*!
\param full_path_name full path to the file to be closed, it cannot be a relative path
\return > 0 the internal index of the file closed, < 0 in case of problems
*/
EXPORTED_FUNCTION int close_file_n(char const* full_path_name);

//! Close a xrk file
/*!
\param idx the internal file index returned by open function
\return > 0 the internal index of the file closed, < 0 in case of problems
*/
EXPORTED_FUNCTION int close_file_i(int idx);

//! Get vehicle info
/*!
\param idx the internal file index returned by open function
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_vehicle_name(int idx);

//! Get track info
/*!
\param idx the internal file index returned by open function
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_track_name(int idx);

//! Get racer info
/*!
\param idx the internal file index returned by open function
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_racer_name(int idx);

//! Get championship info
/*!
\param idx the internal file index returned by open function
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_championship_name(int idx);

//! Get venue type info
/*!
\param idx the internal file index returned by open function
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_venue_type_name(int idx);

//! Get session date and time
/*!
\param idx the internal file index returned by open function
\return a struct tm pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION struct tm const* get_date_and_time(int idx);

//! Get laps count of a xrk file
/*!
\param idx the internal file index returned by open function
\return > 0 the laps count, < 0 in case of problems, 0 in case the xrk file has no laps (theorically not possible)
*/
EXPORTED_FUNCTION int get_laps_count(int idx);

/*!
    Laps information functions
*/

//! Get lap info
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param pstart pointer to an already allocated double in which the start time of the lap will be stored
\param pduration pointer to an already allocated double in which the lap duration will be stored
\return 1 if all is OK, < 0 in case of problems, 0 in case the xrk file has no laps (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_info(int idxf, int idxl, double* pstart, double* pduration);

/*!
    Channels information functions
*/

//! Get channels count of a xrk file
/*!
\param idx the internal file index returned by open function
\return > 0 the channel count, < 0 in case of problems, 0 in case the xrk file has no channels (theorically not possible)
*/
EXPORTED_FUNCTION int get_channels_count(int idx);

//! Get channel name
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_channel_name(int idxf, int idxc);

//! Get channel units
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_channel_units(int idxf, int idxc);

//! Get channel samples count
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_channel_samples_count(int idxf, int idxc);

//! Get channel samples
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_channel_samples(int idxf, int idxc, double* ptimes, double* pvalues, int cnt);

//! Get channel samples count in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_channel_samples_count(int idxf, int idxl, int idxc);

//! Get channel samples in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_channel_samples(int idxf, int idxl, int idxc, double* ptimes, double* pvalues, int cnt);

/*!
    GPS channels information functions, where GPS channels are the same channels added to AiM drk files in RS2Analysis,
    those that consider vehicle dynamics assuming that the vehicle is constantly aligned to the trajectory.
*/

//! Get GPS channels count of a xrk file
/*!
\param idx the internal file index returned by open function
\return > 0 the channel count, < 0 in case of problems, 0 in case the xrk file has no channels (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_channels_count(int idx);

//! Get GPS channel name
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_GPS_channel_name(int idxf, int idxc);

//! Get GPS channel units
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_GPS_channel_units(int idxf, int idxc);

//! Get GPS channel samples count
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_channel_samples_count(int idxf, int idxc);

//! Get GPS channel samples
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_channel_samples(int idxf, int idxc, double* ptimes, double* pvalues, int cnt);

//! Get GPS channel samples count in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_GPS_channel_samples_count(int idxf, int idxl, int idxc);

//! Get GPS channel samples in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_GPS_channel_samples(int idxf, int idxl, int idxc, double* ptimes, double* pvalues, int cnt);

/*!
    GPS raw channels information functions, where GPS raw channels are information in the GPS solution coming directly from the GPS receiver.
*/

//! Get GPS raw channels count of a xrk file
/*!
\param idx the internal file index returned by open function
\return > 0 the channel count, < 0 in case of problems, 0 in case the xrk file has no channels (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_raw_channels_count(int idx);

//! Get GPS raw channel name
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_GPS_raw_channel_name(int idxf, int idxc);

//! Get GPS raw channel units
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return a null terminated char pointer with the required info, NULL in case of problems
*/
EXPORTED_FUNCTION char const* get_GPS_raw_channel_units(int idxf, int idxc);

//! Get GPS raw channel samples count
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_raw_channel_samples_count(int idxf, int idxc);

//! Get GPS raw channel samples
/*!
\param idxf the internal file index returned by open function
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_GPS_raw_channel_samples(int idxf, int idxc, double* ptimes, double* pvalues, int cnt);

//! Get GPS raw channel samples count in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\return > 0 the samples count, < 0 in case of problems, 0 in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_GPS_raw_channel_samples_count(int idxf, int idxl, int idxc);

//! Get GPS raw channel samples in a given lap
/*!
\param idxf the internal file index returned by open function
\param idxl the lap index
\param idxc the channel index
\param ptimes pointer to an already allocated buffer in which sample times will be stored
\param pvalues pointer to an already allocated buffer in which sample values will be stored
\param cnt the number of samples of the buffer, that is the samples count returned by get channel samples count function
\return > 0 the samples count, < 0 in case of problems, 0 in case the cnt param doesn't match the samples count or in case the channel has no samples (theorically not possible)
*/
EXPORTED_FUNCTION int get_lap_GPS_raw_channel_samples(int idxf, int idxl, int idxc, double* ptimes, double* pvalues, int cnt);

#ifdef  __cplusplus
}
#endif

#endif