ca.uhn.hl7v2.model.v231.datatype
Class CD

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v231.datatype.CD

All Implemented Interfaces:

Composite, Type, Serializable

public class CD
extends AbstractType
implements Composite

Represents an HL7 CD (channel definition) data type. This type consists of the following components:

• channel identifier (WVI)
• electrode names (WVS)
• channel sensitivity/units (CSU)
• calibration parameters (CCP)
• sampling frequency (NM)
• minimum/maximum data values (NR)

See Also:

Serialized Form

Constructor Summary

CD(Message message)
Creates a new CD type

Method Summary

CCP	getCalibrationParameters() Returns calibration parameters (component #4).
WVI	getCd1_ChannelIdentifier() Returns channel identifier (component #1).
WVS	getCd2_ElectrodeNames() Returns electrode names (component #2).
CSU	getCd3_ChannelSensitivityUnits() Returns channel sensitivity/units (component #3).
CCP	getCd4_CalibrationParameters() Returns calibration parameters (component #4).
NM	getCd5_SamplingFrequency() Returns sampling frequency (component #5).
NR	getCd6_MinimumMaximumDataValues() Returns minimum/maximum data values (component #6).
WVI	getChannelIdentifier() Returns channel identifier (component #1).
CSU	getChannelSensitivityUnits() Returns channel sensitivity/units (component #3).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
WVS	getElectrodeNames() Returns electrode names (component #2).
NR	getMinimumMaximumDataValues() Returns minimum/maximum data values (component #6).
NM	getSamplingFrequency() Returns sampling frequency (component #5).

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

CD

public CD(Message message)

Creates a new CD type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getChannelIdentifier

public WVI getChannelIdentifier()

Returns channel identifier (component #1). This is a convenience method that saves you from casting and handling an exception.

getCd1_ChannelIdentifier

public WVI getCd1_ChannelIdentifier()

Returns channel identifier (component #1). This is a convenience method that saves you from casting and handling an exception.

getElectrodeNames

public WVS getElectrodeNames()

Returns electrode names (component #2). This is a convenience method that saves you from casting and handling an exception.

getCd2_ElectrodeNames

public WVS getCd2_ElectrodeNames()

Returns electrode names (component #2). This is a convenience method that saves you from casting and handling an exception.

getChannelSensitivityUnits

public CSU getChannelSensitivityUnits()

Returns channel sensitivity/units (component #3). This is a convenience method that saves you from casting and handling an exception.

getCd3_ChannelSensitivityUnits

public CSU getCd3_ChannelSensitivityUnits()

Returns channel sensitivity/units (component #3). This is a convenience method that saves you from casting and handling an exception.

getCalibrationParameters

public CCP getCalibrationParameters()

Returns calibration parameters (component #4). This is a convenience method that saves you from casting and handling an exception.

getCd4_CalibrationParameters

public CCP getCd4_CalibrationParameters()

Returns calibration parameters (component #4). This is a convenience method that saves you from casting and handling an exception.

getSamplingFrequency

public NM getSamplingFrequency()

Returns sampling frequency (component #5). This is a convenience method that saves you from casting and handling an exception.

getCd5_SamplingFrequency

public NM getCd5_SamplingFrequency()

Returns sampling frequency (component #5). This is a convenience method that saves you from casting and handling an exception.

getMinimumMaximumDataValues

public NR getMinimumMaximumDataValues()

Returns minimum/maximum data values (component #6). This is a convenience method that saves you from casting and handling an exception.

getCd6_MinimumMaximumDataValues

public NR getCd6_MinimumMaximumDataValues()

Returns minimum/maximum data values (component #6). This is a convenience method that saves you from casting and handling an exception.