Class FamosFileBuffer
A buffer describes the length and position of component data within the file.
Inheritance
Namespace: ImcFamosFile
Assembly: ImcFamosFile.dll
Syntax
public class FamosFileBuffer
Constructors
| Improve this Doc View SourceFamosFileBuffer()
Creates a new instance of the FamosFileBuffer class.
Declaration
public FamosFileBuffer()
FamosFileBuffer(Byte[])
Creates a new instance of the FamosFileBuffer class.
Declaration
public FamosFileBuffer(byte[] userInfo)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | userInfo | The binary user info. |
Properties
| Improve this Doc View SourceAddTime
Gets or sets the add time, which is used with multiple trigger events to determine the absolute trigger time.
Declaration
public decimal AddTime { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal |
ConsumedBytes
Gets or sets the number of valid bytes in the buffer.
Declaration
public int ConsumedBytes { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
IsNewEvent
Gets or sets a boolean which indicates a new event of measurement data.
Declaration
public bool IsNewEvent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsRingBuffer
Gets a boolean indicating if this buffer is a ring buffer.
Declaration
public bool IsRingBuffer { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Length
Gets or sets the length of the buffer in bytes.
Declaration
public int Length { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Offset
Gets or sets the offset of the first sample in the buffer. REMARKS: If > '0', the buffer is a ring buffer.
Declaration
public int Offset { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
RawBlock
Gets or sets the associated raw block.
Declaration
public FamosFileRawBlock RawBlock { get; set; }
Property Value
Type | Description |
---|---|
FamosFileRawBlock |
RawBlockOffset
Gets or sets the offset of the buffer in the raw block in bytes.
Declaration
public long RawBlockOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
UserInfo
Gets or sets binary user info for the creator of the file.
Declaration
public ReadOnlyCollection<byte> UserInfo { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ReadOnlyCollection<System.Byte> |
X0
Gets or sets the X0 of the first sample in the buffer.
Declaration
public decimal X0 { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal |