com.highqsoft.util.ubh

Class BinaryFormat

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.util.ubh.BinaryFormat

All Implemented Interfaces:

FwkInterface, BinaryFormatInterface, java.io.Serializable

public class BinaryFormat
extends Fwk
implements BinaryFormatInterface

The BinaryFormat.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkPropertyGroupInterface	propertyGroup
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
BinaryFormat(FwkPropertyGroupInterface props) The constructor.

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	getVersion() Return the version string of the FWK component.
java.lang.String	getWordOrder() Order of low and high word in data file.
static void	main(java.lang.String[] args) Main module of this application.
java.lang.String	toString() Print out the string presentation of the class.

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

propertyGroup

protected FwkPropertyGroupInterface propertyGroup

Constructor Detail

BinaryFormat

public BinaryFormat(FwkPropertyGroupInterface props)

The constructor.

Parameters:

props - the property group containing the settings.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class Fwk

getCreatedOnPlatform

public java.lang.String getCreatedOnPlatform()

Creation platform of file (PC, VMS, UNIX)

Specified by:

getCreatedOnPlatform in interface BinaryFormatInterface

Returns:

the plat spec. Default is UNIX

getByteSwapIsNeeded

public 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“.

Specified by:

getByteSwapIsNeeded in interface BinaryFormatInterface

Returns:

the described value.

getByteOrder

public 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

Specified by:

getByteOrder in interface BinaryFormatInterface

Returns:

LSB or MSB.

getWordOrder

public 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

Specified by:

getWordOrder in interface BinaryFormatInterface

Returns:

LSW or MSW

getHeaderGlobalSize

public int getHeaderGlobalSize()

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

Specified by:

getHeaderGlobalSize in interface BinaryFormatInterface

Returns:

the size of the Global Header

getHeaderSignalSize

public int getHeaderSignalSize()

Size of each channel header in bytes.

Specified by:

getHeaderSignalSize in interface BinaryFormatInterface

Returns:

the size of the channel Header

getHeaderFrameSize

public int getHeaderFrameSize()

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

Specified by:

getHeaderFrameSize in interface BinaryFormatInterface

Returns:

the size of the frame Header

getBlocking

public int getBlocking()

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

Specified by:

getBlocking in interface BinaryFormatInterface

Returns:

the size of the frame Header

getBlockCount

public int getBlockCount()

The number of blocks in file.

Specified by:

getBlockCount in interface BinaryFormatInterface

Returns:

the number of blocks in files

getSignalCount

public int getSignalCount()

The number of signals in file.

Specified by:

getSignalCount in interface BinaryFormatInterface

Returns:

the number of signals in files

getDataSignalCount

public 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.

Specified by:

getDataSignalCount in interface BinaryFormatInterface

Returns:

the number of signals in data files

getSignalType

public java.lang.String getSignalType()

Type of signal

Digital or digital for digital signals
Analog: for analoge signals

Specified by:

getSignalType in interface BinaryFormatInterface

Returns:

LSW or MSW

toString

public java.lang.String toString()

Print out the string presentation of the class.

Overrides:

toString in class java.lang.Object

Returns:

the string presentation.

main

public static void main(java.lang.String[] args)

Main module of this application. Normally this application is started via FwkFrame, FwkApplet or FwkApplication. In case somebody wants to run this application directly, this main method is provided. All it does is passing the responsibility directly to FwkFrame.