trek_data_error_codes.h File Reference

Error codes for the Data API (starts at 15001). More...

Macros
#define	TREK_DATA_VALUE_RANGE_ERROR   15001
	The value entered does not meet range criteria for the method.
#define	TREK_DATA_EXT_NUM_SAMP_PARAM_NOT_FOUND   15002
	Could not find the external number of samples parameter. Check database definition.
#define	TREK_DATA_DATA_WILL_NOT_FIT   15003
	The data type is not capable of holding the value.
#define	TREK_DATA_INVALID_START_BIT   15004
	Invalid start bit for a parameter (past end of allowed packet).
#define	TREK_DATA_ALREADY_EXISTS   15005
	The item specified already exists.
#define	TREK_DATA_END_OF_LIST   15006
	No more items are in the list.
#define	TREK_DATA_DOES_NOT_EXIST   15007
	The specified item does not exist. Names are case-sensitive.
#define	TREK_DATA_INVALID_DATA_TYPE   15008
	Data type is not valid.
#define	TREK_DATA_INVALID_LENGTH_FOR_DATA_TYPE   15009
	The data type does not support the specified length.
#define	TREK_DATA_POSSIBLE_LOSS_OF_DATA   15010
	(Considered Success) Function or method call worked, but there may be loss of data (e.g., used a float to set an integer).
#define	TREK_DATA_INVALID_INPUT_FOR_TYPE   15011
	The data type does not allow this method to be used for setting the value.
#define	TREK_DATA_INVALID_BYTE_ORDER   15012
	The byte order specified is not allowed based on the data type and length specified. For example, only BIG_ENDIAN_BYTE_ORDER is allowed for data types that are not on a byte boundary.
#define	TREK_DATA_SAMPLE_DOES_NOT_EXIST   15013
	The sample number specified is greater than the number of samples available for the parameter.
#define	TREK_DATA_INVALID_SAMPLE_NUMBER   15014
	Valid sample numbers are greater than 0.
#define	TREK_DATA_UNEXPECTED_ERROR   15015
	Indicates a likely bug in the TReK code. Please notify the TReK Help desk if this occurs.
#define	TREK_DATA_INVALID_VALUE   15016
	Value is not valid (in a valid range).
#define	TREK_DATA_FIXED_LENGTH_REQUIRED   15017
	Data type cannot be variable length.
#define	TREK_DATA_VALUE_MUST_BE_POSITIVE   15018
	The value passed must be a non-negative number.
#define	TREK_DATA_INVALID_CHAR_INPUT   15019
	The string contains a character that is invalid.
#define	TREK_DATA_INVALID_INPUT_FOR_DATA_TYPE   15020
	The data type does not allow this method to be used for setting the value.
#define	TREK_DATA_WILL_NOT_FIT   15021
	Data is too long for the available space.
#define	TREK_DATA_INVALID_DATA_FORMAT   15022
	Data format is not valid. This indicates a likely bug in the TReK code. Please notify the TReK help desk if this occurs.
#define	TREK_DATA_NOT_BOOLEAN_TYPE   15023
	The input string is not a boolean string (true or false).
#define	TREK_DATA_NOT_MODIFIABLE   15024
	The value cannot be modified. A value marked as unmodifiable that has no value can be set once.
#define	TREK_DATA_VALUE_LESS_THAN_MIN   15025
	Input value is too small for the data type or is less than allowed by the low range.
#define	TREK_DATA_VALUE_EXCEEDS_MAX   15026
	Input value is too large for the data type or is more than allowed by the high range.
#define	TREK_DATA_ZONE_ALREADY_EXISTS   15028
	The specified zone (header, data, or trailer) is already populated.
#define	TREK_DATA_ERROR_BUILDING_HEADER_ZONE   15029
	The header zone of the packet could not be built. Likely causes include parameter values not set.
#define	TREK_DATA_ERROR_BUILDING_DATA_ZONE   15030
	The data zone of the packet could not be built. Likely causes include parameter values not set.
#define	TREK_DATA_ERROR_BUILDING_TRAILER_ZONE   15031
	The trailer zone of the packet could not be built. Likely causes include parameter values not set.
#define	TREK_DATA_NOT_ENOUGH_SPACE   15032
	The specified data buffer is not larger enough to hold the data.
#define	TREK_DATA_MORE_THAN_ONE_PARAMETER   15033
	The reference name appears more than once in the packet hierarchy. Use the fully-qualified name instead.
#define	TREK_DATA_ERROR_BUILDING_LEN_PARAM   15034
	Could not build the length parameter for the packet. Could occur if length parameter is deleted from the packet.
#define	TREK_DATA_LEN_ZONE_ERROR   15035
	Zone is invalid for length. This indicates a likely bug in the TReK code. Please notify the TReK help desk if this occurs.
#define	TREK_DATA_ERROR_BUILDING_COUNTER_PARAM   15036
	Could not build the counter parameter for the packet. Could occur if counter parameter is deleted from the packet.
#define	TREK_DATA_ERROR_BUILDING_TIME_PARAM   15037
	Could not build the time stamp parameter for the packet. Could occur if time stamp parameter is deleted from the packet.
#define	TREK_DATA_ERROR_BUILDING_CHECKSUM_PARAM   15038
	Could not build the checksum parameter for the packet. Could occur if checksum parameter is deleted from the packet.
#define	TREK_DATA_UNKNOWN_LIMIT_TYPE   15039
	Unknown limit type. This indicates a possible bug in the TReK code. Please notify the TReK help desk if this occurs.
#define	TREK_DATA_CALIBRATOR_NOT_DEFINED   15040
	A calibrator is not defined for the parameter.
#define	TREK_DATA_ENUMERATOR_NOT_DEFINED   15041
	An enumerator is not defined for the parameter.
#define	TREK_DATA_RANGE_ERROR   15042
	The data is out of the allowed range.
#define	TREK_DATA_CALIBRATION_ERROR   15043
	An error occurred when attempting to calibrate the parameter.
#define	TREK_DATA_INCORRECT_LIMIT_TYPE   15044
	The specified limit type is incorrect in this context.
#define	TREK_DATA_LIMIT_LEVEL_NOT_IN_USE   15045
	The specified limit level is not currently in use.
#define	TREK_DATA_LIMIT_VALUE_TOO_SMALL   15046
	The limit value is too small for this context.
#define	TREK_DATA_LIMIT_VALUE_TOO_LARGE   15047
	The limit value is too large for this context.
#define	TREK_DATA_LIMIT_LEVEL_ERROR   15048
	The value is not a valid limit level.
#define	TREK_DATA_NEG_LEN_ERROR   15049
	The calculated length is negative. This likely indicates that the input data is too short or the offset defined for the length is incorrect.
#define	TREK_DATA_NO_VALUE   15050
	Parameter has no value defined.
#define	TREK_DATA_NO_PARENT   15051
	Parent packet not defined. Likely an initialization problem.
#define	TREK_DATA_EXT_NUM_SAMP_VALUE_FAIL   15052
	Could not get a value for the external number of samples.
#define	TREK_DATA_EXT_NUM_SAMP_EXTRACT_FAIL   15053
	Could not extract the value for the external number of samples.
#define	TREK_DATA_EXT_NUM_SAMP_BAD_VALUE   15054
	The external number of samples is either zero or too large.
#define	TREK_DATA_ENUMERATION_DOES_NOT_EXIST   15055
	The value does not have an associated enumeration defined.
#define	TREK_DATA_MISSING_ZONE   15056
	The zone does not currently exist.
#define	TREK_DATA_ERROR_BUILDING_IDENTIFIER   15057
	Could not build an identifier parameter for the packet.
#define	TREK_DATA_EXT_STATUS_PARAM_NOT_FOUND   15058
	Could not find the external status parameter. Check database definition.
#define	TREK_DATA_EXT_STATUS_VALUE_FAIL   15059
	Could not get a value for the external status.
#define	TREK_DATA_EXT_STATUS_EXTRACT_FAIL   15060
	Could not extract the value for the external status.
#define	TREK_DATA_CONVERSION_ERROR   15061
	Data has error making it unconvertable.
#define	TREK_LAST_BIT_ERROR   15062
	Last bit is past the end of the packet.
#define	TREK_DATA_COULD_NOT_LOAD_LIBRARY   15063
	Could not load user created library.
#define	TREK_DATA_COULD_NOT_FIND_LIB_FUNCTION   15064
	Could not find function in user library.
#define	TREK_DATA_INVALID_LENGTH   15065
	The length for the parameter is not correct in this context.
#define	TREK_DATA_VAR_LEN_NUM_SAMPLE_ERROR   15066
	Variable length data must have a single sample.
#define	TREK_DATA_UNKNOWN_ZONE   15067
	Could not convert a zone string to an enumerator. Possibly indicates a TReK bug. Please contact the TReK help desk.
#define	TREK_DATA_UNKNOWN_ID_TYPE   15068
	Could not convert an identifier type string to an enumerator. Possibly indicates a TReK bug. Please contact the TReK help desk.
#define	TREK_DATA_UNKNOWN_CHECKSUM_POINT   15070
	Could not convert a checksum point string to an enumerator. Possibly indicates a TReK bug. Please contact the TReK help desk.
#define	TREK_DATA_UNKNOWN_CHECKSUM_TYPE   15071
	Could not convert a checksum type string to an enumerator. Possibly indicates a TReK bug. Please contact the TReK help desk.
#define	TREK_DATA_FILE_ACCESS_ERROR   15072
	Could not access file. May not have read or write privileges on the directory or file.
#define	TREK_DATA_NO_VERSION_INFO   15073
	Version information was required, but not available. Likely cause is an XML file that was edited improperly.
#define	TREK_DATA_XML_FMT_ERROR   15074
	An element in XML was not properly formatted.
#define	TREK_DATA_UNEXPECTED_XML_ELEMENT   15075
	An unexpected element was found in the XML.
#define	TREK_DATA_UNKNOWN_XML_VERSION   15076
	The XML version is likely from a new version of TReK. Check that you are using the latest version of code for compile, link, and run.
#define	TREK_DATA_COULD_NOT_CALC_START_PT   15077
	Could not calculate the start point for the checksum. Most likely cause is that two or more 'zones' have variable length data which is not supported at this time.
#define	TREK_DATA_COULD_NOT_CALC_END_PT   15078
	Could not calculate the start point for the checksum. Most likely cause is that two or more 'zones' have variable length data which is not supported at this time.
#define	TREK_DATA_CHECKSUM_START_PT_ERROR   15079
	The calculated start point for the checksum is either prior to the start of the packet or past the end of it.
#define	TREK_DATA_CHECKSUM_END_PT_ERROR   15080
	The calculated end point for the checksum is either prior to the start of the packet or past the end of it.
#define	TREK_DATA_CHECKSUM_PT_SWAP_ERROR   15081
	The calculated end point is not after the calculated start point for the checksum.
#define	TREK_DATA_HASH_SIZE_ERROR   15082
	Indicates that a third-party library used for checksum calculations has changed. Please report this error to the TReK Help Desk.
#define	TREK_DATA_TIME_ERROR   15083
	Error retrieving time.
#define	TREK_DATA_FRACTIONAL_TIME_VALUE_ERROR   15084
	Fractional seconds is greater than allowed for current time settings.
#define	TREK_DATA_NEG_TIME_NOT_ALLOWED   15085
	Negative time is not allowed.
#define	TREK_DATA_TIME_LENGTH_ERROR   15086
	Time strings must be 19 characters or between 21 and 32 characters inclusive.
#define	TREK_DATA_TIME_STRING_FORMAT_ERROR   15087
	Time string format is incorrect. See allowed formats in trek::TrekTime.
#define	TREK_DATA_TIME_TOO_SOON   15088
	Times prior to midnight January 1, 1970 are not supported.
#define	TREK_DATA_ILLEGAL_MONTH   15089
	The month value must be between 1 and 12 inclusive. Note: Must represent months prior to 10 with a leading zero (e.g., 03).
#define	TREK_DATA_ILLEGAL_DAY   15090
	The day value is not correct for the specified month.
#define	TREK_DATA_ILLEGAL_HOURS   15091
	The hour value must be between 0 and 23 inclusive. Note: Must represent hours prior to 10 with a leading zero (e.g., 02).
#define	TREK_DATA_ILLEGAL_MINUTES   15092
	The minute value must be between 0 and 59 inclusive. Note: Must represent minutes prior to 10 with a leading zero (e.g., 07).
#define	TREK_DATA_ILLEGAL_SECONDS   15093
	The second value must be less than 60. Fractional second values are allowed, but seconds prior to 10 with a leading zero (e.g., 01).
#define	TREK_DATA_NULL_PTR   15094
	Returned when one or more arguments for a function are unexpectedly NULL.
#define	TREK_DATA_BAD_INDEX   15095
	The index specified does not exist.
#define	TREK_DATA_PACKET_LENGTH_ERROR   15096
	The packet length has an error. For extraction this likely indicates the data being extracted is incomplete.
#define	TREK_DATA_CHECKSUM_ERROR   15097
	The checksum in the packet does not match the calculated checksum.
#define	TREK_DATA_MUST_BE_NON_ZERO   15098
	The data value cannot be zero.
#define	TREK_DATA_MUST_HAVE_VALUE   15099
	Either a default or expected value is required.
#define	TREK_DATA_NOT_IN_ZONE   15101
	The parameter is not in the zone specified.
#define	TREK_DATA_MOD_ZERO   15102
	The modulo value must be greater than zero.
#define	TREK_DATA_REMAINDER_TOO_LARGE   15103
	The remainder value must be less than the modulo value.
#define	TREK_DATA_VALIDATION_ERROR   15104
	Returned if Validation fails. A validation string containing detailed errors is available.
#define	TREK_DATA_NO_IDENTIFIER   15105
	An identifier could not be found when required.
#define	TREK_DATA_ID_MISMATCH   15106
	There are one or more identifiers that do not match.
#define	TREK_DATA_NOT_ALLOWED   15107
	Whatever you are trying isn't allowed.
#define	TREK_DATA_TIME_TOO_LATE   15108
	Times past December 31, 2099 are not supported.
#define	TREK_DATA_IS_INVALID   15109
	The data is currently invalid and must be validated prior to use of this method.
#define	TREK_DATA_INCORRECT_SWITCH_TYPE   15110
	The configured switch type is incorrect for this method.
#define	TREK_DATA_LOW_TO_HIGH   15111
	The low value must be greater than the high value.
#define	TREK_DATA_NEED_UNIQUE_RANGE   15112
	The range overlaps with a range that is already defined.
#define	TREK_DATA_SWITCH_ERROR   15113
	An error occurred when switching sets.
#define	TREK_DATA_BAD_SYLLABLE_NUMBER   15114
	Syllable number exceeds the number of syllables defined.
#define	TREK_DATA_VAR_LEN_SYLLABLE_ERROR   15115
	Variable length data cannot have multiple syllables.
#define	TREK_DATA_COULD_NOT_OPEN_FILE   15116
	Could not open a file.
#define	TREK_DATA_LIMIT_ALARM_MISMATCH   15117
	Cannot add different limit alarm types.

Detailed Description

Error codes for the Data API (starts at 15001).