Trek

Classes
struct	trek::packet_identifier_struct
	Structure of information needed for identifier parameters. More...

Typedefs
typedef enum identifier_types	identifier_types
	Enumeration of types of identifiers.

Enumerations
enum	trek::limit_type {   trek::DOUBLE_LIMITS ,   trek::INT_LIMITS ,   trek::UINT_LIMITS }
	Enumeration of limit types allowed. More...
enum	trek::lass_limit_type {   trek::LASS_NONE ,   trek::LASS_DOUBLE_LIMITS ,   trek::LASS_INT_LIMITS ,   trek::LASS_UINT_LIMITS }
	Enumeration of limit type for set. More...
enum	trek::packet_zone_type {   trek::HEADER_ZONE ,   trek::DATA_ZONE ,   trek::TRAILER_ZONE }
	Enumeration of packet zones. More...
enum	trek::packet_checksum_point_type {   trek::START_HEADER ,   trek::START_DATA ,   trek::END_DATA ,   trek::END_TRAILER }
	Enumeration of start and end points for checksums. More...
enum	trek::packet_checksum_type {   trek::CT_CRC32 ,   trek::CT_MD5 ,   trek::CT_SUM16 }
	Enumeration of checksum types allowed. More...
enum	trek::parameter_data_type {   trek::DT_TWOS_COMPLEMENT ,   trek::DT_UNSIGNED_INTEGER ,   trek::DT_BINARY_CODED_DECIMAL ,   trek::DT_DISTENDED_SIGNED_INTEGER ,   trek::DT_SIGN_AND_MAGNITUDE_INTEGER ,   trek::DT_IEEE_FLOATING_POINT ,   trek::DT_NULL_TERMINATED_STRING ,   trek::DT_FIXED_LENGTH_STRING ,   trek::DT_BOOLEAN ,   trek::DT_UNSPECIFIED_BYTES ,   trek::DT_GPS_EPOCH_TIME ,   trek::DT_EHS_TIME ,   trek::DT_ISS_TIME ,   trek::DT_FASTSAT_TIME ,   trek::DT_DEM_TIME ,   trek::DT_UNIX_TIME ,   trek::DT_EHS_CONV_TIME ,   trek::DT_ISAT_TIME }
	Enumeration of all valid data types for TReK. More...
enum	trek::parameter_data_format {   trek::DF_ASCII ,   trek::DF_BINARY ,   trek::DF_DECIMAL ,   trek::DF_SCIENTIFIC ,   trek::DF_HEX ,   trek::DF_BOOLEAN ,   trek::DF_DATE_TIME }
	Enumeration of all valid data formats for TReK values as strings. More...
enum	trek::switch_type {   trek::RANGE_SWITCH ,   trek::ENUMERATION_SWITCH }
	Enumeration of switch types. More...
enum	byte_order_type {   BIG_ENDIAN_BYTE_ORDER = 0 ,   LITTLE_ENDIAN_BYTE_ORDER ,   BYTE_SWAPPED_BYTE_ORDER ,   WORD_SWAPPED_BYTE_ORDER }
	Byte order enumeration. More...
enum	identifier_types {   FIXED_VALUE_IDENTIFIER ,   USER_SELECTABLE_IDENTIFIER ,   CONTENT_IDENTIFIER }
	Enumeration of types of identifiers. More...

Detailed Description

Enumeration Type Documentation

byte_order_type

enum byte_order_type

Byte order enumeration.

Enumerator
BIG_ENDIAN_BYTE_ORDER	Also known as network byte order. Most significant byte is first.
LITTLE_ENDIAN_BYTE_ORDER	Least significant byte is first.
BYTE_SWAPPED_BYTE_ORDER	Each byte in a 16-bit word is swapped.
WORD_SWAPPED_BYTE_ORDER	Each 16-bit word in a 32-bit word is swapped.

identifier_types

enum identifier_types

Enumeration of types of identifiers.

Enumerator
FIXED_VALUE_IDENTIFIER	must always be a value (important enough to check)
USER_SELECTABLE_IDENTIFIER	used to identify packet, but must be set at 'run time'
CONTENT_IDENTIFIER	used to determine content of packet

lass_limit_type

enum trek::lass_limit_type

Enumeration of limit type for set.

Enumerator
LASS_NONE	None (no limit alarms have been added to the switch set)
LASS_DOUBLE_LIMITS	Double limits (used for floating point numbers and calibrated data)
LASS_INT_LIMITS	Integer limits (used for data converted to signed integers that are not calibrated)
LASS_UINT_LIMITS	Unsigned limits (used for data converted to unsigned integers that are not calibrated)

limit_type

enum trek::limit_type

Enumeration of limit types allowed.

Enumerator
DOUBLE_LIMITS	Double limits (used for floating point numbers and calibrated data)
INT_LIMITS	Integer limits (used for data converted to signed integers that are not calibrated)
UINT_LIMITS	Unsigned limits (used for data converted to unsigned integers that are not calibrated)

packet_checksum_point_type

enum trek::packet_checksum_point_type

Enumeration of start and end points for checksums.

Enumerator
START_HEADER	Start of header (beginning of packet)
START_DATA	Start of data (or end of header if you prefer)
END_DATA	End of data (or start of trailer if you prefer)
END_TRAILER	End of trailer (end of packet)

packet_checksum_type

enum trek::packet_checksum_type

Enumeration of checksum types allowed.

Enumerator
CT_CRC32	32-bit Cyclic redundance check (see ???)
CT_MD5	MD5 sum (see ???)
CT_SUM16	sum of 16-bit words ignoring overflow

packet_zone_type

enum trek::packet_zone_type

Enumeration of packet zones.

Enumerator
HEADER_ZONE	Header (first) zone in packet.
DATA_ZONE	Data (second) zone in packet.
TRAILER_ZONE	Trailer (last) zone in packet.

parameter_data_format

enum trek::parameter_data_format

Enumeration of all valid data formats for TReK values as strings.

Enumerator
DF_ASCII	ASCII string data.
DF_BINARY	All characters must be either 0 or 1.
DF_DECIMAL	Characters must be 0-9. A period ('.') is allowed for floating point data.
DF_SCIENTIFIC	Currently not supported.
DF_HEX	All characters must be 0-9, a-f, or A-F.
DF_BOOLEAN	Valid values are 'true' and 'false'. Capitalization does not matter.
DF_DATE_TIME	Valid values are of the form: YYYY-MM-DD HH:MM:SS.SSS where the .SSS is optional.

parameter_data_type

enum trek::parameter_data_type

Enumeration of all valid data types for TReK.

Enumerator
DT_TWOS_COMPLEMENT	Two's complement integer value ranging from 2 to 64 bits in length.
DT_UNSIGNED_INTEGER	Unsigned integer value ranging from 1 to 64 bits in length.
DT_BINARY_CODED_DECIMAL	Binary coded decimal from 1 to 4 digits (4 to 16 bits)
DT_DISTENDED_SIGNED_INTEGER	Lowest 12 bits contain the magnitude and the most significant bit is the sign. All other bits ignored.
DT_SIGN_AND_MAGNITUDE_INTEGER	Most significant bit is sign all others are magnitude. 2 to 32 bits in length.
DT_IEEE_FLOATING_POINT	IEEE floating point value. Single precision is 32 bits. Double precision is 64 bits.
DT_NULL_TERMINATED_STRING	ASCII string terminated by a NULL (0x00) character.
DT_FIXED_LENGTH_STRING	ASCII string of fixed length that may or may not contain a terminating character.
DT_BOOLEAN	Single bit value where 1 indicates true and 0 indicates false.
DT_UNSPECIFIED_BYTES	Binary data that has no type. From 1 to 65,000 bytes.
DT_GPS_EPOCH_TIME	32 bit seconds since midnight January 6, 1980
DT_EHS_TIME	48, 52, or 56 bit time found in the EHS Primary Protocol Header. 52 and 56 bit versions have resolution to one tenth of a second.
DT_ISS_TIME	40 bits (32-bit seconds since GPS plus 8 bit fractional time...1 bit = ~4ms)
DT_FASTSAT_TIME	32 bit GPS plus 16 bit fractional milliseconds (max value 999).
DT_DEM_TIME	32 bit GPS plus 10 bit fractional milliseconds (max value 999).
DT_UNIX_TIME	32 bits seconds since midnight January 1, 1970
DT_EHS_CONV_TIME	320 bit time used exclusively for 'converted' time data in EHS GSE Packets.
DT_ISAT_TIME	32 bits seconds since midnight January 1, 1970 plus 16 bit milliseconds

switch_type

enum trek::switch_type

Enumeration of switch types.

Enumerator
RANGE_SWITCH	Range switch (low < value <= high)
ENUMERATION_SWITCH	Enumerator switch (value == "string")