CCSDSPack
C++ Library for CCSDS Space Packet manipulation. i.e. generation, extraction, analisys and more
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations
CCSDS Namespace Reference

Contains definitions and classes for handling CCSDS headers. More...

Classes

class  BufferHeader
 Represents a fixed secondary header used as a data buffer. More...
 
struct  CRC16Config
 Configuration structure for CRC16 calculation parameters. More...
 
class  DataField
 Represents the data field of a CCSDS packet. More...
 
class  Error
 Represents an error with both an error code and a message. More...
 
class  Header
 Manages the decomposition and manipulation of CCSDS primary headers. More...
 
class  Manager
 Manages CCSDS packets and their templates. More...
 
class  Packet
 Represents a CCSDS (Consultative Committee for Space Data Systems) packet. More...
 
struct  PrimaryHeader
 Represents the primary header of a CCSDS packet. More...
 
class  Result
 Encapsulates a result that can hold either a value or an Error. More...
 
class  SecondaryHeaderAbstract
 Abstract base class for a (Packet Utilization Standard) header. More...
 
class  SecondaryHeaderFactory
 A singleton factory class responsible for registering and creating instances of SecondaryHeaderAbstract objects. More...
 
class  Validator
 Handles validation of CCSDS packets. More...
 

Typedefs

using ResultBool = Result< bool >
 
using ResultBuffer = Result< std::vector< uint8_t > >
 

Enumerations

enum  ESequenceFlag : uint8_t { CONTINUING_SEGMENT , FIRST_SEGMENT , LAST_SEGMENT , UNSEGMENTED }
 Represents the sequence flags used in CCSDS telemetry transfer frames. More...
 
enum  ErrorCode : uint8_t {
  NONE = 0 , UNKNOWN_ERROR = 1 , NO_DATA = 2 , INVALID_DATA = 3 ,
  INVALID_HEADER_DATA = 4 , INVALID_SECONDARY_HEADER_DATA = 5 , INVALID_APPLICATION_DATA = 6 , NULL_POINTER = 7 ,
  INVALID_CHECKSUM = 8 , VALIDATION_FAILURE = 9 , SOMETHING_WENT_WRONG = 10 , FILE_READ_ERROR = 11 ,
  FILE_WRITE_ERROR = 12 , CONFIG_FILE_ERROR = 13
}
 Defines various error codes used in CCSDS packet handling. More...
 

Detailed Description

Contains definitions and classes for handling CCSDS headers.

Contains result handling utilities for CCSDS packet processing.

Typedef Documentation

◆ ResultBool

using CCSDS::ResultBool = typedef Result<bool>

Definition at line 131 of file CCSDSResult.h.

◆ ResultBuffer

using CCSDS::ResultBuffer = typedef Result<std::vector<uint8_t> >

Definition at line 132 of file CCSDSResult.h.

Enumeration Type Documentation

◆ ErrorCode

enum CCSDS::ErrorCode : uint8_t

Defines various error codes used in CCSDS packet handling.

Enumerator
NONE 

No error.

UNKNOWN_ERROR 

Unknown error.

NO_DATA 

No data available.

INVALID_DATA 

Data is invalid.

INVALID_HEADER_DATA 

Header data is invalid.

INVALID_SECONDARY_HEADER_DATA 

Secondary header data is invalid.

INVALID_APPLICATION_DATA 

Application data is invalid.

NULL_POINTER 

Null pointer encountered.

INVALID_CHECKSUM 

Checksum validation failed.

VALIDATION_FAILURE 

Validation Failure.

SOMETHING_WENT_WRONG 

General failure.

FILE_READ_ERROR 

Reading from file failure.

FILE_WRITE_ERROR 

Writing to file failure.

CONFIG_FILE_ERROR 

Definition at line 19 of file CCSDSResult.h.

19 : uint8_t {
20 NONE = 0,
21 UNKNOWN_ERROR = 1,
22 NO_DATA = 2,
23 INVALID_DATA = 3,
27 NULL_POINTER = 7,
31 FILE_READ_ERROR = 11,
32 FILE_WRITE_ERROR = 12,
34 };
@ NO_DATA
No data available.
Definition CCSDSResult.h:22
@ NONE
No error.
Definition CCSDSResult.h:20
@ FILE_READ_ERROR
Reading from file failure.
Definition CCSDSResult.h:31
@ UNKNOWN_ERROR
Unknown error.
Definition CCSDSResult.h:21
@ INVALID_CHECKSUM
Checksum validation failed.
Definition CCSDSResult.h:28
@ INVALID_APPLICATION_DATA
Application data is invalid.
Definition CCSDSResult.h:26
@ INVALID_DATA
Data is invalid.
Definition CCSDSResult.h:23
@ INVALID_HEADER_DATA
Header data is invalid.
Definition CCSDSResult.h:24
@ CONFIG_FILE_ERROR
Definition CCSDSResult.h:33
@ SOMETHING_WENT_WRONG
General failure.
Definition CCSDSResult.h:30
@ VALIDATION_FAILURE
Validation Failure.
Definition CCSDSResult.h:29
@ FILE_WRITE_ERROR
Writing to file failure.
Definition CCSDSResult.h:32
@ INVALID_SECONDARY_HEADER_DATA
Secondary header data is invalid.
Definition CCSDSResult.h:25
@ NULL_POINTER
Null pointer encountered.
Definition CCSDSResult.h:27

◆ ESequenceFlag

enum CCSDS::ESequenceFlag : uint8_t

Represents the sequence flags used in CCSDS telemetry transfer frames.

This enum defines the possible sequence flag values that indicate the type and position of a data segment in a telemetry frame:

  • CONTINUING_SEGMENT: An intermediate segment of a packet.
  • FIRST_SEGMENT: The first segment of a new packet.
  • LAST_SEGMENT: The last segment of a packet that spans multiple frames.
  • UNSEGMENTED: A complete unsegmented packet contained in a single frame.
Enumerator
CONTINUING_SEGMENT 

00 Intermediate segment of a packet.

FIRST_SEGMENT 

01 First segment of a new packet.

LAST_SEGMENT 

10 Last segment of a multi-frame packet.

UNSEGMENTED 

11 Complete packet in a single frame.

Definition at line 19 of file CCSDSHeader.h.

19 : uint8_t {
24 };
@ LAST_SEGMENT
10 Last segment of a multi-frame packet.
Definition CCSDSHeader.h:22
@ UNSEGMENTED
11 Complete packet in a single frame.
Definition CCSDSHeader.h:23
@ CONTINUING_SEGMENT
00 Intermediate segment of a packet.
Definition CCSDSHeader.h:20
@ FIRST_SEGMENT
01 First segment of a new packet.
Definition CCSDSHeader.h:21