Module otdrs::types

Base library for otdrs

Structs

BlockInfo	A BlockInfo struct contains information about a specific block later in the file, and appears in the MapBlock
DataPoints	DataPoints holds all the different datasets in this file - one per scale factor
DataPointsAtScaleFactor	DataPointsAtScaleFactor is the struct that actually contains the data points of the measurements for a given scale factor
FixedParametersBlock	Fixed parameters block contains key information for interpreting the test data
GeneralParametersBlock	The GeneralParametersBlock is mandatory for the format and contains test-identifying information as well as generic information about the test being run such as the nominal wavelength
KeyEvent	KeyEvents describe a single event along the fibre path detected by the OTDR
KeyEvents	List of key events and a pointer to the last key event
Landmark	Landmarks are a slightly esoteric feature not often used in SOR files for field test equipment. They act to relate OTDR events to real-world information such as WGS84 GPS data, known fibre MFDs, metre markers, etc
LastKeyEvent	The last key event is as the KeyEvent, with some additional fields; see KeyEvent for the documentation of other fields
LinkParameters	LinkParameters are a bit esoteric and not often found in test equipment, more the likes of network management systems. Contains a set of landmarks which describe the physical fibre path and may relate this to described KeyEvents
MapBlock	Every SOR file has a MapBlock which acts as a map to the file’s contents
ProprietaryBlock	ProprietaryBlock is a struct to contain third-party proprietary information. This is mostly used for vendor-specific special sauce, extra data, extra analysis, etc. otdrs extracts the header, and stores the data as an array of bytes.
SORFile	SORFile describes a full SOR file. All blocks except MapBlock are Option types as we cannot guarantee the parser will find them, but many blocks are in fact mandatory in the specification so compliant files will provide them.
SupplierParametersBlock	Supplier parameters describe the OTDR unit itself, such as the optical module ID/serial number. Often this block also contains information about calibration dates in the “other” field.