Class FamosFilePackInfo

A pack info fully describes the data layout.

Inheritance
System.Object
FamosFileBase
FamosFilePackInfo
Namespace: ImcFamosFile
Assembly: ImcFamosFile.dll
Syntax
public class FamosFilePackInfo : FamosFileBase

Constructors

| Improve this Doc View Source

FamosFilePackInfo(FamosFileDataType)

Initializes a new instance of the FamosFilePackInfo class.

Declaration
public FamosFilePackInfo(FamosFileDataType dataType)
Parameters
Type Name Description
FamosFileDataType dataType

The data type.
| Improve this Doc View Source

FamosFilePackInfo(FamosFileDataType, List<FamosFileBuffer>)

Initializes a new instance of the FamosFilePackInfo class.

Declaration
public FamosFilePackInfo(FamosFileDataType dataType, List<FamosFileBuffer> buffers)
Parameters
Type Name Description
FamosFileDataType dataType

The data type.
System.Collections.Generic.List<FamosFileBuffer> buffers

A list of buffers.

Properties

| Improve this Doc View Source

Buffers

Gets a list of associated buffers.

Declaration
public List<FamosFileBuffer> Buffers { get; }
Property Value
Type Description
System.Collections.Generic.List<FamosFileBuffer>
| Improve this Doc View Source

ByteGapSize

Gets or sets the number of bytes between two groups of values of this component. REMARKS: Equal to '0', if the data are not interlaced.

Declaration
public int ByteGapSize { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ByteRowSize

Gets the number of bytes per row (if the data are interlaced).

Declaration
public int ByteRowSize { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DataType

Gets or sets the data type.

Declaration
public FamosFileDataType DataType { get; set; }
Property Value
Type Description
FamosFileDataType
| Improve this Doc View Source

GroupSize

Gets or sets the number of subsequent values in the raw data block. REMARKS: Equal to '1', if the data are not interlaced.

Declaration
public int GroupSize { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

IsContiguous

Gets a bool indicating if the component is contiguous (= not interlaced).

Declaration
public bool IsContiguous { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Mask

Gets or sets the bit mask. For digital (binary 0 or 1) data = 0. REMARKS: For digital (binary 0 or 1) data = 0. Otherwise, for analog data, a mask with all invalid bits, which should be ignored. EXAMPLE: For example 3, where the two lowest bits should be ignored. Mask is defined with a decimal without a sign(0.. 65534). At least 1 bit must be valid.

Declaration
public int Mask { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Offset

Gets or set the offset of the first sample in the binary data block. REMARKS: The offset is counted from the first valid measurement value in the buffer. The offset is a logical offset, thus is always >= 0 in ring buffer with data overflowing forward.

Declaration
public int Offset { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SignificantBits

Gets or sets the number of significant bits.

Declaration
public int SignificantBits { get; set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Validate()

Validates the key status.

Declaration
public override void Validate()
Overrides