ScanHeader Struct Reference

The data is passed from SctApi to the outside world in this (file) format. More...

#include <scan.h>

Data Fields
UINT16	version
	header version
UINT16	length
	header length
UINT32	runNumber
	run number
UINT32	scanNumber
	scan number
char	moduleName [16]
	Serial number.
char	startTime [16]
	Start UTC time in ISO format (with no Z appended).
char	endTime [16]
	Start UTC time in ISO format (with no Z appended).
UINT16	scanType
	As defined in AbcdScans.h.
UINT16	npoints
	Number of scan points.
UINT32	size
	Size of data block in 16bit words - note that this is different from the logic format of the data - see the streamers.
UINT16	dataType
	Datatype as defined in dataTypes.h.
UINT16	width
	Width of data - either 0 (N/A), 16, 32bits.
ABCDModule	config
	Don't need to know how big it is (look at length).
UINT32	pntPoints
	Index to point data from beginning of file.
UINT32	pntEvents
	Index to event data from beginning of file.
UINT32	pntErrors
	Index to error data from beginning of file.
UINT32	pntData
	Index to histogram data from beginning of file.

---

Detailed Description

The data is passed from SctApi to the outside world in this (file) format.

Definition at line 14 of file scan.h.

---

Field Documentation

ABCDModule ScanHeader::config

Don't need to know how big it is (look at length). Definition at line 32 of file scan.h. Referenced by SctApi::readRawData(), and SctData::ScanResultWriter::writeConfiguration().

UINT16 ScanHeader::dataType

Datatype as defined in dataTypes.h. Definition at line 29 of file scan.h. Referenced by SctData::ScanResultWriter::publish(), SctApi::readRawData(), SctData::SliceDataWriter::writeData(), SctData::ScanResultWriter::writeData(), and SctData::RawDataWriter::writeData().

char ScanHeader::endTime[16]

Start UTC time in ISO format (with no Z appended). Definition at line 23 of file scan.h. Referenced by SctData::ScanResultWriter::writeHeader().

UINT16 ScanHeader::length

header length Definition at line 16 of file scan.h. Referenced by SctApi::readRawData(), and SctApi::saveHistogramToFile().

char ScanHeader::moduleName[16]

Serial number. Definition at line 20 of file scan.h. Referenced by SctApi::readRawData(), and SctData::ScanResultWriter::writeHeader().

UINT16 ScanHeader::npoints

Number of scan points. Definition at line 26 of file scan.h. Referenced by SctApi::readRawData(), and SctData::ScanResultWriter::writeScanPoints().

UINT32 ScanHeader::pntData

Index to histogram data from beginning of file. Definition at line 37 of file scan.h. Referenced by SctApi::readRawData(), and SctApi::saveHistogramToFile().

UINT32 ScanHeader::pntErrors

Index to error data from beginning of file. Definition at line 36 of file scan.h. Referenced by SctApi::readRawData(), and SctApi::saveHistogramToFile().

UINT32 ScanHeader::pntEvents

Index to event data from beginning of file. Definition at line 35 of file scan.h. Referenced by SctApi::readRawData(), and SctApi::saveHistogramToFile().

UINT32 ScanHeader::pntPoints

Index to point data from beginning of file. Definition at line 34 of file scan.h. Referenced by SctApi::readRawData(), and SctApi::saveHistogramToFile().

UINT32 ScanHeader::runNumber

run number Definition at line 17 of file scan.h. Referenced by SctApi::readRawData(), and SctData::ScanResultWriter::writeHeader().

UINT32 ScanHeader::scanNumber

scan number Definition at line 18 of file scan.h. Referenced by SctApi::ScanControlRODHisto::readHistograms(), SctApi::readRawData(), and SctData::ScanResultWriter::writeHeader().

UINT16 ScanHeader::scanType

As defined in AbcdScans.h. Definition at line 25 of file scan.h. Referenced by SctApi::readRawData(), and SctData::ScanResultWriter::writeHeader().

UINT32 ScanHeader::size

Size of data block in 16bit words - note that this is different from the logic format of the data - see the streamers. Definition at line 28 of file scan.h. Referenced by SctApi::readRawData(), SctApi::saveHistogramToFile(), SctData::SliceDataWriter::writeData(), and SctData::RawDataWriter::writeData().

char ScanHeader::startTime[16]

Start UTC time in ISO format (with no Z appended). Definition at line 22 of file scan.h. Referenced by SctData::ScanResultWriter::writeHeader().

UINT16 ScanHeader::version

header version Definition at line 15 of file scan.h. Referenced by SctApi::readRawData().

UINT16 ScanHeader::width

Width of data - either 0 (N/A), 16, 32bits. Definition at line 30 of file scan.h. Referenced by SctApi::readRawData(), SctData::SliceDataWriter::writeData(), and SctData::RawDataWriter::writeData().

---

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

• scan.h

---