trek_user_api_dotnet.h File Reference

The .NET version of the TReK Release 3 API (trek_telemetry_dotnet_api). More...

#include <windows.h>
#include <stdexcept>
#include "trek.h"
#include "trek_error.h"
#include "trek_user_api.h"

Classes
class	trek::trek_user_api
	‍**************************************************************** More...

Enumerations
enum class	trek::TREK_USER_API_RETURN_CODES

Detailed Description

The .NET version of the TReK Release 3 API (trek_telemetry_dotnet_api).

Enumeration Type Documentation

TREK_USER_API_RETURN_CODES

enum class trek::TREK_USER_API_RETURN_CODES

strong

api_INVALID_PACKET_TYPE 35001
The packet type is not one of the allowed types: PDSS_PAYLOAD, GSE, CCSDS, SCS, PRCU, EXPRESS, GSE_MERGE, UFO, PDSS_CORE.

api_INVALID_PARAMETER_TYPE 35002
The parameter type is not of of the allowed types: EHS_PACKET, CCSDS_PACKET, MSID, EXPRESS, or UFO.

api_INVALID_MSID 35004
The parameter name is not valid.

api_INVALID_DATA_MODE 35005
The data mode is not one of the allowed modes.

api_INVALID_APID 35006
The APID is outside of the allowed range.

api_TOO_MANY_SAMPLES 35007
Not considered an error. Returned if the number of samples available is less than the number of samples requested.

api_PARAMETER_NOT_FOUND 35008
Parameter not found. Check the spelling of the parameter name. Also check that the packet type and data mode are correct.

api_NO_DATA_AVAILABLE 35010
Returned if there is no data available. This can occur when a packet has been initialized, but the TReK system has not yet received any packets of data containing the parameter.

api_NO_NEW_DATA 35012
Returned if there is no new data available.

api_CALIBRATION_NOT_DEFINED 35013
Calibration is not defined for this parameter.

api_INCORRECT_DATATYPE 35014
Returned if the data to be returned is not the correct datatype. For example, if using GetOne...IntegerValue() and data was actually a string then this error would be returned because this function only returns integer data.

api_NOT_ENOUGH_SPACE 35016
The memory allocated for the returned value is not large enough. Check the returned size of data to see what is the minimum needed.

api_INVALID_LIMIT_ES_FLAG 35020
The limit/expected state (LES) flag must be 0 (No LES sensing) or 1 (Check for LES errors).

api_MEMORY_ERROR 35022
General memory error. Could indicate a problem with data definition.

api_DATA_SIZE_ERROR 35023
Error associated with data size. Check metadata definition for accuracy.

api_MORE_DATA_AVAILABLE 35024
Returned if there is more data available for this parameter. This indicates that another GetNext... call can be made to retrieve new data.

api_WAIT_FAILED 35029
The API failed while waiting for TReK to return data. If you see this error, please contact the TReK help desk.

api_WAIT_ABANDONED 35030
The API abandoned waiting for TReK to return data. If you see this error, please contact the TReK help desk.

api_WAIT_TIMEOUT 35031
The API timed out while waiting for TReK to return data. This error could indicate that your computer is unable to process the amount of data being requested.

api_ERROR_ATTACHING_THREAD 35032
Not used anymore.

api_UNKNOWN_RETURN_CODE 35033
Not used anymore. The 'unknown' return code is passed back for help in understanding problems.

Examples

Telemetry_Dotnet_Example/Program.cs.