cdac.medinfo.sdk.dcm30_04.baselibs

Class WaveformSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.WaveformSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class WaveformSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of WaveformSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ChannelDefinitionSequence	getChannelDefinitionSequence() Retrieves pre-initialized object of Channel Definition Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getMultiplexGroupLabel() Return attribute identifies Label for multiplex group
java.lang.String	getMultiplexGroupTimeOffset() Return attribute Offset time in milliseconds from a reference time
short	getNumberofWaveformChannels() Retrieves Number of channels for this multiplex group.
short	getNumberofWaveformSamples() Retrieves Number of samples per channel in this multiplex group.
java.lang.String	getSamplingFrequency() Return attribute identifies Sampling Frequency
short	getTriggerSamplePosition() Retrieves Sample number whose time corresponds to a synchronization trigger
java.lang.String	getTriggerTimeOffset() Return attribute identifies Offset time in milliseconds from a synchronization trigger to the first sample of a waveform multiplex group.
short	getWaveformBitsAllocated() Retrieves Size of each waveform data sample within the Waveform Data
ISingleCollection<byte[]>	getWaveformData() Return value of the Encoded data samples - channel multiplexed
java.lang.String	getWaveformOriginality() Retrieves Attribute Waveforn Originality
ISingleCollection<byte[]>	getWaveformPaddingValue() Return attribute identifies Value of waveform samples inserted in channels when input is absent or invalid
java.lang.String	getWaveformSampleInterpretation() Return attribute identifies Data representation of the waveform data points.
void	setMultiplexGroupLabel(java.lang.String StrMultiplexGroupLabel) Sets attribute identifies Label for multiplex group
void	setMultiplexGroupTimeOffset(java.lang.String StrMultiplexGroupTimeOffset) Sets attribute Offset time in milliseconds from a reference time
void	setNumberofWaveformChannels(short shNumberofWaveformChannels) Sets Number of channels for this multiplex group.
void	setNumberofWaveformSamples(short shNumberofWaveformSamples) Sets Number of samples per channel in this multiplex group.
void	setSamplingFrequency(java.lang.String StrSamplingFrequency) Sets attribute identifies Sampling Frequency
void	setTriggerSamplePosition(short shTriggerSamplePosition) Sets Sample number whose time corresponds to a synchronization trigger
void	setTriggerTimeOffset(java.lang.String StrTriggerTimeOffset) Sets attribute identifies Offset time in milliseconds from a synchronization trigger to the first sample of a waveform multiplex group.
void	setWaveformBitsAllocated(EnumWaveformBitsAllocated enumWaveformBitsAllocated) Sets Size of each waveform data sample within the Waveform Data
void	setWaveformData(ISingleCollection<byte[]> objWaveformData) Sets Encoded data samples - channel multiplexed
void	setWaveformOriginality(EnumWaveformOriginality enumWaveformOriginality) Sets Attribute Waveforn Originality Enumerated values: ORIGINAL DERIVED
void	setWaveformPaddingValue(ISingleCollection<byte[]> objWaveformPaddingValue) Sets attribute identifies Value of waveform samples inserted in channels when input is absent or invalid
void	setWaveformSampleInterpretation(EnumWaveformSampleInterpretation enumWaveformSampleInterpretation) Sets attribute identifies Data representation of the waveform data points.
boolean	validateForModule() Validates all the attributes in WaveformSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in WaveformSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setMultiplexGroupTimeOffset

public void setMultiplexGroupTimeOffset(java.lang.String StrMultiplexGroupTimeOffset)

Sets attribute Offset time in milliseconds from a reference time

Parameters:

StrMultiplexGroupTimeOffset - String time in milliseconds from a reference time

getMultiplexGroupTimeOffset

public java.lang.String getMultiplexGroupTimeOffset()

Return attribute Offset time in milliseconds from a reference time

Returns:

String - identifies the time in milliseconds from a reference time

setTriggerTimeOffset

public void setTriggerTimeOffset(java.lang.String StrTriggerTimeOffset)

Sets attribute identifies Offset time in milliseconds from a synchronization trigger to the first sample of a waveform multiplex group. May be positive or negative.

Parameters:

StrTriggerTimeOffset - String Offset time in milliseconds

getTriggerTimeOffset

public java.lang.String getTriggerTimeOffset()

Return attribute identifies Offset time in milliseconds from a synchronization trigger to the first sample of a waveform multiplex group. May be positive or negative.

Returns:

String - Offset time in milliseconds

setTriggerSamplePosition

public void setTriggerSamplePosition(short shTriggerSamplePosition)

Sets Sample number whose time corresponds to a synchronization trigger

Parameters:

shTriggerSamplePosition - short value of Sample number

getTriggerSamplePosition

public short getTriggerSamplePosition()

Retrieves Sample number whose time corresponds to a synchronization trigger

Returns:

short - short value of Sample number

setWaveformOriginality

public void setWaveformOriginality(EnumWaveformOriginality enumWaveformOriginality)

Sets Attribute Waveforn Originality Enumerated values: ORIGINAL DERIVED

Parameters:

enumWaveformOriginality - short value of High Bit.

getWaveformOriginality

public java.lang.String getWaveformOriginality()

Retrieves Attribute Waveforn Originality

Returns:

String - value of Waveforn Originality

setNumberofWaveformChannels

public void setNumberofWaveformChannels(short shNumberofWaveformChannels)

Sets Number of channels for this multiplex group.

Parameters:

shNumberofWaveformChannels - short value of Number of channels

getNumberofWaveformChannels

public short getNumberofWaveformChannels()

Retrieves Number of channels for this multiplex group.

Returns:

short - short value of Number of channels

setNumberofWaveformSamples

public void setNumberofWaveformSamples(short shNumberofWaveformSamples)

Sets Number of samples per channel in this multiplex group.

Parameters:

shNumberofWaveformSamples - short value of Number of samples

getNumberofWaveformSamples

public short getNumberofWaveformSamples()

Retrieves Number of samples per channel in this multiplex group.

Returns:

short - short value of Number of samples

setSamplingFrequency

public void setSamplingFrequency(java.lang.String StrSamplingFrequency)

Sets attribute identifies Sampling Frequency

Parameters:

StrSamplingFrequency - String identifies the Sampling Frequency

getSamplingFrequency

public java.lang.String getSamplingFrequency()

Return attribute identifies Sampling Frequency

Returns:

String - identifies the Sampling Frequency

setMultiplexGroupLabel

public void setMultiplexGroupLabel(java.lang.String StrMultiplexGroupLabel)

Sets attribute identifies Label for multiplex group

Parameters:

StrMultiplexGroupLabel - String Label for multiplex group

getMultiplexGroupLabel

public java.lang.String getMultiplexGroupLabel()

Return attribute identifies Label for multiplex group

Returns:

String - identifies Label for multiplex group

getChannelDefinitionSequence

public ChannelDefinitionSequence getChannelDefinitionSequence()

Retrieves pre-initialized object of Channel Definition Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ChannelDefinitionSequence - instance of Channel Definition Sequence

setWaveformBitsAllocated

public void setWaveformBitsAllocated(EnumWaveformBitsAllocated enumWaveformBitsAllocated)

Sets Size of each waveform data sample within the Waveform Data

Parameters:

enumWaveformBitsAllocated - enum value of Bits Allocated

getWaveformBitsAllocated

public short getWaveformBitsAllocated()

Retrieves Size of each waveform data sample within the Waveform Data

Returns:

short - short value of Bits Allocated

setWaveformSampleInterpretation

public void setWaveformSampleInterpretation(EnumWaveformSampleInterpretation enumWaveformSampleInterpretation)

Sets attribute identifies Data representation of the waveform data points.

Parameters:

enumWaveformSampleInterpretation - Enum identifies the Waveform Sample Interpretation

getWaveformSampleInterpretation

public java.lang.String getWaveformSampleInterpretation()

Return attribute identifies Data representation of the waveform data points.

Returns:

String - identifies the Waveform Sample Interpretation

setWaveformPaddingValue

public void setWaveformPaddingValue(ISingleCollection<byte[]> objWaveformPaddingValue)

Sets attribute identifies Value of waveform samples inserted in channels when input is absent or invalid

Parameters:

objWaveformPaddingValue - ISingle Collection of bytes.

getWaveformPaddingValue

public ISingleCollection<byte[]> getWaveformPaddingValue()

Return attribute identifies Value of waveform samples inserted in channels when input is absent or invalid

Returns:

Collection of byte[] - returns the collection of Waveforn Padding value

setWaveformData

public void setWaveformData(ISingleCollection<byte[]> objWaveformData)

Sets Encoded data samples - channel multiplexed

Parameters:

objWaveformData - ISingle Collection of bytes.

getWaveformData

public ISingleCollection<byte[]> getWaveformData()

Return value of the Encoded data samples - channel multiplexed

Returns:

Collection of byte[] - returns the collection of channel multiplexed