mm::capture::Summary Struct Reference

The summary of one capture. More...

#include <summary.h>

Collaboration diagram for mm::capture::Summary:

Public Attributes
uint64_t	frames = 0
	Every record in the capture.
uint64_t	notEtherCat = 0
	Records that are not an EtherCAT command frame.
uint64_t	unmatchedReturns = 0
int64_t	firstNs = 0
	Timestamp of the first record.
int64_t	lastNs = 0
	Timestamp of the last record.
KindSummary	control
	Mailbox and register datagrams.
KindSummary	cyclic
	The process-data frame.

Detailed Description

The summary of one capture.

A frame is matched to its return by the rule the SOEM port uses: the index, the command, the offset and the length of its first datagram, and its position for every command the slaves do not count up. The first later frame from the slaves with that header is the return. The kind is the first datagram's command: a logical read or write is the cyclic frame of the RT loop, everything else is the control plane. The bands are the three waits the port uses, and they are cumulative.

Member Data Documentation

control

KindSummary mm::capture::Summary::control

Mailbox and register datagrams.

cyclic

KindSummary mm::capture::Summary::cyclic

The process-data frame.

firstNs

int64_t mm::capture::Summary::firstNs = 0

Timestamp of the first record.

frames

uint64_t mm::capture::Summary::frames = 0

Every record in the capture.

lastNs

int64_t mm::capture::Summary::lastNs = 0

Timestamp of the last record.

notEtherCat

uint64_t mm::capture::Summary::notEtherCat = 0

Records that are not an EtherCAT command frame.

unmatchedReturns

uint64_t mm::capture::Summary::unmatchedReturns = 0

Frames from the slaves with no send to match, such as the second answer to a frame sent twice.

---

The documentation for this struct was generated from the following file:

• libs/capture/summary.h