Includes: | <stdio.h>
<iostream>
<fstream>
<string>
<vector>
<exception>
<cstdint>
<time.h> |
Introduction
Use the links in the table of contents to the left to access the documentation.
Classes
- hComm
- hCommTCPSocket
- HyperionException
Structs and Unions
- hReadHeader
- hResponse
- hWriteHeader
struct hReadHeader {
uint8_t status;
uint8_t requestOptionEcho;
uint16_t messageLength;
uint32_t contentLength;
};
Fields
-
status uint8_t The status of the command execution.
-
requestOptionEcho uint8_t A copy of the request option that was originally sent to the instrument when the command was written.
-
messageLength uint16_t The length of the returned message, in bytes.
-
contentLength uint32_t The length of the returned content, in bytes.
Discussion
header that is received with every response from the instrument
struct hResponse {
uint16_t messageLength;
std::string message;
uint32_t contentLength;
uint8_t *content;
};
Fields
-
messageLength uint16_t The length of the returned message, in bytes.
-
message string containing the human-readable message that is returned from the instrument.
-
contentLength uint32_t The length of the returned content, in bytes.
-
content Pointer to a buffer containing the returned data.
Discussion
Encapsulates the returned response from an executed command.
struct hWriteHeader {
uint8_t requestOption;
uint8_t reserved;
uint16_t commandSize;
uint32_t argSize;
};
Fields
-
requestOption uint8_t containing flags that determine the output format returned from the instrument.
-
reserved uint8_t reserved for future use.
-
commandSize uint16_t the number of bytes in the command to be written.
-
argSize uint32_t the number of bytes in the argument to be written.
Discussion
header that is written out before every command
Last Updated: Wednesday, February 11, 2015
|