exported fields FNC_VALUES and RECORD_LAYOUT

also added a description to staticRecordLayout

Author: asap2Go

a2l/fnc_values.go

@@ -7,17 +7,20 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-type fncValues struct {
+// FncValues defines the way the data of a specific record layout is stored within the hex file.
+type FncValues struct {
 	//Position of table values (function values) in the deposit structure (description of sequence of elements in the data record).
 	Position    uint16
 	PositionSet bool
-	//data type of the table values
+	//Datatype of the table values
 	Datatype    dataTypeEnum
 	DatatypeSet bool
-	//for characteristic maps, curves and value blocks, this field is used to describe how the 2-dimensional table values are mapped onto the 1-dimensional address space
+	/*IndexMode for characteristic maps, curves and value blocks,
+	this field is used to describe how the 2-dimensional table values
+	are mapped onto the 1-dimensional address space*/
 	IndexMode    indexModeEnum
 	IndexModeSet bool
-	/*addressing of the table values:
+	/*Addresstype defines the addressing of the table values:
 	Enumeration for description of the addressing of table
 	values or axis point values:
 	PBYTE:	The relevant memory location has a 1 byte pointer
@@ -32,8 +35,8 @@ type fncValues struct {
 	AddresstypeSet bool
 }
 
-func parseFncValues(tok *tokenGenerator) (fncValues, error) {
-	fv := fncValues{}
+func parseFncValues(tok *tokenGenerator) (FncValues, error) {
+	fv := FncValues{}
 	var err error
 forLoop:
 	for {

a2l/module.go

@@ -30,7 +30,7 @@ type module struct {
 	Measurements           map[string]measurement
 	ModCommon              modCommon
 	ModPar                 modPar
-	RecordLayouts          map[string]recordLayout
+	RecordLayouts          map[string]RecordLayout
 	transformers           map[string]transformer
 	typeDefAxis            map[string]typeDefAxis
 	typeDefBlobs           map[string]typeDefBlob
@@ -57,7 +57,7 @@ func parseModule(tok *tokenGenerator) (module, error) {
 	myModule.ifData = make(map[string]IfData, 1000)
 	myModule.instances = make(map[string]instance, 10)
 	myModule.Measurements = make(map[string]measurement, 10000)
-	myModule.RecordLayouts = make(map[string]recordLayout, 1000)
+	myModule.RecordLayouts = make(map[string]RecordLayout, 1000)
 	myModule.transformers = make(map[string]transformer, 10)
 	myModule.typeDefAxis = make(map[string]typeDefAxis, 10)
 	myModule.typeDefBlobs = make(map[string]typeDefBlob, 10)
@@ -79,7 +79,7 @@ func parseModule(tok *tokenGenerator) (module, error) {
 	var bufIfData IfData
 	var bufInstance instance
 	var bufMeasurement measurement
-	var bufRecordLayout recordLayout
+	var bufRecordLayout RecordLayout
 	var bufTransformer transformer
 	var bufTypeDefAxis typeDefAxis
 	var bufTypeDefBlob typeDefBlob
@@ -340,7 +340,7 @@ func parseModuleMultithreaded(tok *tokenGenerator) (module, error) {
 	myModule.ifData = make(map[string]IfData, 1000)
 	myModule.instances = make(map[string]instance, 10)
 	myModule.Measurements = make(map[string]measurement, 10000)
-	myModule.RecordLayouts = make(map[string]recordLayout, 1000)
+	myModule.RecordLayouts = make(map[string]RecordLayout, 1000)
 	myModule.transformers = make(map[string]transformer, 10)
 	myModule.typeDefAxis = make(map[string]typeDefAxis, 10)
 	myModule.typeDefBlobs = make(map[string]typeDefBlob, 10)
@@ -387,7 +387,7 @@ forLoop:
 	cMeasurement := make(chan measurement, 1000)
 	cModCommon := make(chan modCommon, 1)
 	cModPar := make(chan modPar, 1)
-	cRecordLayout := make(chan recordLayout, 100)
+	cRecordLayout := make(chan RecordLayout, 100)
 	cTransformer := make(chan transformer, 10)
 	cTypeDefAxis := make(chan typeDefAxis, 10)
 	cTypeDefBlob := make(chan typeDefBlob, 10)
@@ -456,7 +456,7 @@ func collectChannelsMultithreaded(myModule *module, cA2ml chan a2ml, cAxisPts ch
 	cCompuMethod chan compuMethod, cCompuTab chan compuTab, cCompuVtab chan compuVTab,
 	cCompuVtabRange chan compuVTabRange, cFrame chan frame, cFunction chan function,
 	cGroup chan group, cIfData chan IfData, cMeasurement chan measurement,
-	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan recordLayout,
+	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan RecordLayout,
 	cInstance chan instance, cTransformer chan transformer, cTypeDefAxis chan typeDefAxis,
 	cTypeDefBlob chan typeDefBlob, cTypeDefCharacteristic chan typeDefCharacteristic,
 	cTypeDefMeasurement chan typeDefMeasurement, cTypeDefStructure chan typeDefStructure,
@@ -667,7 +667,7 @@ func closeChannelsAfterParsing(wg *sync.WaitGroup, cA2ml chan a2ml, cAxisPts cha
 	cCompuMethod chan compuMethod, cCompuTab chan compuTab, cCompuVtab chan compuVTab,
 	cCompuVtabRange chan compuVTabRange, cFrame chan frame, cFunction chan function,
 	cGroup chan group, cIfData chan IfData, cMeasurement chan measurement,
-	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan recordLayout,
+	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan RecordLayout,
 	cInstance chan instance, cTransformer chan transformer, cTypeDefAxis chan typeDefAxis,
 	cTypeDefBlob chan typeDefBlob, cTypeDefCharacteristic chan typeDefCharacteristic,
 	cTypeDefMeasurement chan typeDefMeasurement, cTypeDefStructure chan typeDefStructure,
@@ -710,7 +710,7 @@ func parseModuleMainLoop(wg *sync.WaitGroup, minIndex int, maxIndex int,
 	cCompuMethod chan compuMethod, cCompuTab chan compuTab, cCompuVtab chan compuVTab,
 	cCompuVtabRange chan compuVTabRange, cFrame chan frame, cFunction chan function,
 	cGroup chan group, cIfData chan IfData, cMeasurement chan measurement,
-	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan recordLayout,
+	cModCommon chan modCommon, cModPar chan modPar, cRecordLayout chan RecordLayout,
 	cInstance chan instance, cTransformer chan transformer, cTypeDefAxis chan typeDefAxis,
 	cTypeDefBlob chan typeDefBlob, cTypeDefCharacteristic chan typeDefCharacteristic,
 	cTypeDefMeasurement chan typeDefMeasurement, cTypeDefStructure chan typeDefStructure,
@@ -733,7 +733,7 @@ func parseModuleMainLoop(wg *sync.WaitGroup, minIndex int, maxIndex int,
 	var bufIfData IfData
 	var bufInstance instance
 	var bufMeasurement measurement
-	var bufRecordLayout recordLayout
+	var bufRecordLayout RecordLayout
 	var bufTransformer transformer
 	var bufTypeDefAxis typeDefAxis
 	var bufTypeDefBlob typeDefBlob

a2l/record_layout.go

@@ -6,7 +6,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-type recordLayout struct {
+type RecordLayout struct {
 	name                 string
 	nameSet              bool
 	alignmentByte        alignmentByte
@@ -32,7 +32,7 @@ type recordLayout struct {
 	fixNoAxisPtsZ        fixNoAxisPtsZ
 	fixNoAxisPts4        fixNoAxisPts4
 	fixNoAxisPts5        fixNoAxisPts5
-	FncValues            fncValues
+	FncValues            FncValues
 	identification       identification
 	noAxisPtsX           noAxisPtsX
 	noAxisPtsY           noAxisPtsY
@@ -66,8 +66,8 @@ type recordLayout struct {
 	staticAddressOffsets staticAddressOffsetsKeyword
 }
 
-func parseRecordLayout(tok *tokenGenerator) (recordLayout, error) {
-	rl := recordLayout{}
+func parseRecordLayout(tok *tokenGenerator) (RecordLayout, error) {
+	rl := RecordLayout{}
 	var err error
 forLoop:
 	for {

a2l/static_record_layout.go

@@ -2,6 +2,17 @@ package a2l
 
 import "github.com/rs/zerolog/log"
 
+/*staticRecordLayoutKeyword states that
+for calibration objects with a dynamic number of axis points
+the calibration object does not compact or expand data
+when removing or inserting axis points.
+All record layout elements are stored at the same address
+as for the max. number of axis points specified at the calibration object -
+independent of the actual number of axis points.
+If the parameter STATIC_RECORD_LAYOUT is missing,
+the calibration objects referencing this record layout do compact / extend data when
+removing resp. inserting axis points and the addresses of the record layout elements
+depend on the actual number of axis points.*/
 type staticRecordLayoutKeyword struct {
 	value    bool
 	valueSet bool