Sidereon.CCSDS.TDM.Comment (Sidereon v3.0.0)

A comment and where it sits.

text is everything after the COMMENT keyword and the one space CCSDS 503.0-B-2 4.5.3 requires, leading indentation included. before_record is the index of the field or record the comment precedes in its block: header fields counting CCSDS_TDM_VERS as index 0, metadata fields, or data records. A comment at or past the end of its block sits after the last one.

CCSDS 503.0-B-2 4.5.2 puts comments at the top of their section, so a conforming header comment has before_record: 1 and a conforming metadata or data comment before_record: 0. Another position is kept, and written back where it was under a policy that forgives :keyword_order.

Summary

Types

t()

Types

t()

@type t() :: %Sidereon.CCSDS.TDM.Comment{
  before_record: non_neg_integer(),
  text: String.t()
}