CCSDS::Validator Class Reference

Handles validation of CCSDS packets. More...

#include <CCSDSValidator.h>

Collaboration diagram for CCSDS::Validator:

Public Member Functions
	Validator ()=default
	Default constructor.
	~Validator ()=default
	Default destructor.
	Validator (const Packet &templatePacket)
	Constructs a Validator with a template packet.
void	setTemplatePacket (const Packet &templatePacket)
	Sets the template packet for validation.
void	configure (bool validatePacketCoherence, bool validateSequenceCount, bool validateAgainstTemplate)
	Configures validation options.
bool	validate (const Packet &packet)
	Validates a given packet.
std::vector< bool >	getReport () const
	Returns a report of performed validation checks.
void	clear ()
	Clears the validator, resets counter.

Private Attributes
Packet	m_templatePacket
	Template packet used for validation.
bool	m_validatePacketCoherence {true}
	Whether to validate packet length and CRC (default is true).
bool	m_validateAgainstTemplate {false}
	Whether to validate against the template packet (default is false).
bool	m_validateSegmentedCount {true}
	Whether to validate the count of segmented packets.
uint16_t	m_sequenceCounter {1}
	Counter for segmented Packets.
std::vector< bool >	m_report {}
	List of boolean results representing performed checks.
size_t	m_reportSize {6}
	Expected size of the validation report.
CRC16Config	m_CRCConfig

Detailed Description

Handles validation of CCSDS packets.

The Validator class checks packet coherence and compares packets against a template.

Definition at line 14 of file CCSDSValidator.h.

Constructor & Destructor Documentation

Validator() [1/2]

CCSDS::Validator::Validator ( )

default

Default constructor.

~Validator()

CCSDS::Validator::~Validator ( )

default

Default destructor.

Validator() [2/2]

CCSDS::Validator::Validator ( const Packet &  templatePacket )

inlineexplicit

Constructs a Validator with a template packet.

Parameters

templatePacket

The packet template to use for validation.

Definition at line 26 of file CCSDSValidator.h.

                                                     : m_templatePacket(templatePacket) {
    };

Member Function Documentation

clear()

void CCSDS::Validator::clear

(

)

Clears the validator, resets counter.

Definition at line 62 of file CCSDSValidator.cpp.

                           {
  m_sequenceCounter = 1;
  m_report.clear();
  m_templatePacket = {};
  m_templatePacket.setUpdatePacketEnable(false);
}

configure()

void CCSDS::Validator::configure	(	bool	validatePacketCoherence,
		bool	validateSequenceCount,
		bool	validateAgainstTemplate
	)

Configures validation options.

Parameters

validatePacketCoherence	Enables/disables packet coherence validation.
validateSequenceCount
validateAgainstTemplate	Enables/disables comparison against the template.

Definition at line 4 of file CCSDSValidator.cpp.

                                                                                                                                 {
  m_validatePacketCoherence = validatePacketCoherence;
  m_validateAgainstTemplate = validateAgainstTemplate;
}

Here is the caller graph for this function:

getReport()

std::vector< bool > CCSDS::Validator::getReport ( ) const

inline

Returns a report of performed validation checks.

• Packet Coherence:
  • index [0]: Data Field Length Header declared equals actual data field length
  • index [1]: CRC15 value declared equals calculated CRC16 of the data field
  • index [2]: Sequence Control flags and count coherence
  • index [3]: Sequence Control count coherence (incremental start from 1)
• Compare Against Template:
  • index [4]: Identification and Version in packet matches template
  • index [5]: Template Sequence Control match

Returns

A vector of boolean results for each performed check.

Definition at line 64 of file CCSDSValidator.h.

{ return m_report; }

setTemplatePacket()

void CCSDS::Validator::setTemplatePacket ( const Packet &  templatePacket )

inline

Sets the template packet for validation.

Parameters

templatePacket

The new template packet.

Definition at line 33 of file CCSDSValidator.h.

{ m_templatePacket = templatePacket; }

Here is the caller graph for this function:

validate()

bool CCSDS::Validator::validate

(

const Packet &

packet

)

Validates a given packet.

Parameters

packet

The packet to validate.

Returns

True if the packet passes validation, otherwise false.

Definition at line 9 of file CCSDSValidator.cpp.

                                                  {
  m_report.clear();
  m_report.reserve(m_reportSize);
  m_report.assign({true, true, true, true, true, true});
  bool result{true};
  auto toValidate = packet;
  toValidate.setUpdatePacketEnable(false);
  auto toValidateHeader = toValidate.getPrimaryHeader();
  const auto toValidateHeaderData = toValidateHeader.serialize();
  // auto coherence checks
  const auto dataFieldBytes = toValidate.getFullDataFieldBytes();
  const auto dataFieldBytesSize = dataFieldBytes.size();
 
  // test CRC therefore full data field coherence
  if (m_validatePacketCoherence) {
    m_report[0] = toValidateHeader.getDataLength() == dataFieldBytesSize;
    result &= m_report[0];
    const auto calcCRC = crc16(dataFieldBytes);
    m_report[1] = calcCRC == toValidate.getCRC();
    result &= m_report[1];
    if (toValidateHeader.getSequenceFlags() == UNSEGMENTED) {
      m_report[2] = toValidateHeader.getSequenceCount() == 0;
    } else {
      m_report[2] = toValidateHeader.getSequenceCount() > 0;
      if (m_validateSegmentedCount) {
        if (toValidateHeader.getSequenceFlags() == FIRST_SEGMENT) {
          m_report[3] = toValidateHeader.getSequenceCount() == 1;
        }else {
          m_report[3] = toValidateHeader.getSequenceCount() == m_sequenceCounter;
        }
        m_sequenceCounter++;
      }
    }
    result &= m_report[2];
    result &= m_report[3];
  }
 
  if (m_validateAgainstTemplate) {
    m_templatePacket.setUpdatePacketEnable(false);
    auto templateHeader = m_templatePacket.getPrimaryHeader();
    const auto templateHeaderData = templateHeader.serialize();
    m_report[4] = templateHeaderData[0] == toValidateHeaderData[0] && templateHeaderData[1] == toValidateHeaderData[1];
    result &= m_report[4];
    if (templateHeader.getSequenceFlags() == UNSEGMENTED) {
      m_report[5] = toValidateHeader.getSequenceFlags() == UNSEGMENTED;
    } else {
      m_report[5] = toValidateHeader.getSequenceFlags() != UNSEGMENTED;
    }
    result &= m_report[5];
  }
  return result;
}

Here is the call graph for this function:

Member Data Documentation

m_CRCConfig

CRC16Config CCSDS::Validator::m_CRCConfig

private

Definition at line 80 of file CCSDSValidator.h.

m_report

std::vector<bool> CCSDS::Validator::m_report {}

private

List of boolean results representing performed checks.

Definition at line 78 of file CCSDSValidator.h.

{};          

m_reportSize

size_t CCSDS::Validator::m_reportSize {6}

private

Expected size of the validation report.

Definition at line 79 of file CCSDSValidator.h.

{6};                

m_sequenceCounter

uint16_t CCSDS::Validator::m_sequenceCounter {1}

private

Counter for segmented Packets.

Definition at line 77 of file CCSDSValidator.h.

{1};         

m_templatePacket

Packet CCSDS::Validator::m_templatePacket

private

Template packet used for validation.

Definition at line 73 of file CCSDSValidator.h.

m_validateAgainstTemplate

bool CCSDS::Validator::m_validateAgainstTemplate {false}

private

Whether to validate against the template packet (default is false).

Definition at line 75 of file CCSDSValidator.h.

{false}; 

m_validatePacketCoherence

bool CCSDS::Validator::m_validatePacketCoherence {true}

private

Whether to validate packet length and CRC (default is true).

Definition at line 74 of file CCSDSValidator.h.

{true};  

m_validateSegmentedCount

bool CCSDS::Validator::m_validateSegmentedCount {true}

private

Whether to validate the count of segmented packets.

Definition at line 76 of file CCSDSValidator.h.

{true};  

---

The documentation for this class was generated from the following files:

• inc/CCSDSValidator.h
• src/CCSDSValidator.cpp