com.highqsoft.util.ubh

Interface BinaryFormatInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

BinaryFormat

public interface BinaryFormatInterface
extends FwkInterface

The BinaryFormatInterface.

Since:

$Date: 2017/04/06 13:29:14 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
int	getBlockCount() The number of blocks in file.
int	getBlocking() Blocking, 1=channel multiplexed, e.g. 512=blockmultiplexed.
java.lang.String	getByteOrder() Order of low and high byte in data file LSB First : low-Byte, high-Byte MSB First : high-Byte, low-Byte
int	getByteSwapIsNeeded() Return a value specifing whether a byle swap is needed.
java.lang.String	getCreatedOnPlatform() Creation platform of file (PC, VMS, UNIX)
int	getDataSignalCount() Number of signals in the data file, if differs from the SignalCount.
int	getHeaderFrameSize() Size of each frame header, at the beginning of each data block in bytes.
int	getHeaderGlobalSize() Size of the global header at the beginning of the file in bytes.
int	getHeaderSignalSize() Size of each channel header in bytes.
int	getSignalCount() The number of signals in file.
java.lang.String	getSignalType() Type of signal Digital or digital for digital signals Analog: for analoge signals
java.lang.String	getWordOrder() Order of low and high word in data file.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Method Detail

getCreatedOnPlatform

java.lang.String getCreatedOnPlatform()

Creation platform of file (PC, VMS, UNIX)

Returns:

the plat spec. Default is UNIX

getByteSwapIsNeeded

int getByteSwapIsNeeded()

Return a value specifing whether a byle swap is needed. Is on the platform of creation a byte swap from host- to netorder needed? If this value differs from the one of the actual platform UB is used, the a byte swap is performed.

0 = byte swap as on this platform
1 = no byte swap
2 = byte swap

REMARK : this setting is only for compatibility reasons supported. It should be replaced by the settings „ByteOrder“ and „WordOrder“.

Returns:

the described value.

getByteOrder

java.lang.String getByteOrder()

Order of low and high byte in data file

LSB First : low-Byte, high-Byte
MSB First : high-Byte, low-Byte

Returns:

LSB or MSB.

getWordOrder

java.lang.String getWordOrder()

Order of low and high word in data file.

LSW First : low-Word, high-Word
MSW First : high-Word, low-Word

Returns:

LSW or MSW

getHeaderGlobalSize

int getHeaderGlobalSize()

Size of the global header at the beginning of the file in bytes.

Returns:

the size of the Global Header

getHeaderSignalSize

int getHeaderSignalSize()

Size of each channel header in bytes.

Returns:

the size of the channel Header

getHeaderFrameSize

int getHeaderFrameSize()

Size of each frame header, at the beginning of each data block in bytes.

Returns:

the size of the frame Header

getBlocking

int getBlocking()

Blocking, 1=channel multiplexed, e.g. 512=blockmultiplexed.

Returns:

the size of the frame Header

getBlockCount

int getBlockCount()

The number of blocks in file.

Returns:

the number of blocks in files

getSignalCount

int getSignalCount()

The number of signals in file.

Returns:

the number of signals in files

getDataSignalCount

int getDataSignalCount()

Number of signals in the data file, if differs from the SignalCount. If DataSignalCount is given, this value will be used to calculate the size of the data blocks.

Returns:

the number of signals in data files

getSignalType

java.lang.String getSignalType()

Type of signal

Digital or digital for digital signals
Analog: for analoge signals

Returns:

LSW or MSW