com.highqsoft.moma.rules.input.tdms

Class TDMSReaderRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.input.tdms.TDMSReaderRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class TDMSReaderRule
extends AbstractRule

\page InputRules \section rules_com_highqsoft_moma_rules_input_tdms_TDMSReaderRule TDMSReaderRule \addindex tdms \addindex from rule tdms Package com.highqsoft.moma.rules.input.tdms This rule reads the given TDMS data file and copy the raw data of the channels into the btf file. The rule returns a NameValueUnit[][] with the file properties from the tdms file. Additionally the TDMSParser object is stored a moma reference. With this reference it is possible to retrieve the group- and channel properties from the tdms file.
The arguments of the class com.highqsoft.moma.rules.input.TDMSReaderRule are listed in the following table. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
TdmsInFileName	String	-	The name of the tdms input file, which should be parsed. (mandatory)
MomaTdmsParserReferenceName	String	-	The name of the context reference for saving thd TDMSParser object. (mandatory)
BtfOutFileName	String	-	The file name for writing the btf data. (mandatory)
BtfFlagOutFileName	String	-	The file name for writing the btf file with the flags. (mandatory)
Encoding	String	UTF-8	The encoding for text values. (optional)
Timezone	String	UTC	The timezone for conterting date-time data fields. (optional)

An example of the usage of the rule is given below: \verbatim \endverbatim

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	encoding
protected java.util.logging.Logger	messenger
protected java.io.File	tdmsFile
protected java.lang.String	tdmsInFileName
protected java.lang.String	timezone

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
TDMSReaderRule()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue method, read the attribute values from the diadem header file.
void	init() Initialization
void	setValue(NameValueUnit[][] nvu) The setValue, create

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, terminate, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

messenger

protected java.util.logging.Logger messenger

tdmsInFileName

protected java.lang.String tdmsInFileName

tdmsFile

protected java.io.File tdmsFile

encoding

protected java.lang.String encoding

timezone

protected java.lang.String timezone

Constructor Detail

TDMSReaderRule

public TDMSReaderRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Initialization

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, read the attribute values from the diadem header file.

Returns:

The name value of the rule.

Throws:

TDMSParserException

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

setValue

public void setValue(NameValueUnit[][] nvu)

The setValue, create

Parameters:

nvu - The name value of the rule.