View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "CD.java".  Description:
15   * "Composite class CD"
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2013.  All Rights Reserved.
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  package ca.uhn.hl7v2.model.v27.datatype;
34  
35  import ca.uhn.hl7v2.model.DataTypeException;
36  import ca.uhn.hl7v2.model.Message;
37  import ca.uhn.hl7v2.model.Type;
38  import ca.uhn.hl7v2.model.AbstractComposite;
39  
40  
41  /**
42   * <p>Represents an HL7 CD (Channel Definition) data type. 
43   * This type consists of the following components:</p>
44   * <ul>
45   * <li>Channel Identifier (WVI)
46   * <li>Waveform Source (WVS)
47   * <li>Channel Sensitivity and Units (CSU)
48   * <li>Channel Calibration Parameters (CCP)
49   * <li>Channel Sampling Frequency (NM)
50   * <li>Minimum and Maximum Data Values (NR)
51   * </ul>
52   */
53  @SuppressWarnings("unused")
54  public class CD extends AbstractComposite {
55  
56      private Type[] data;
57  
58      /** 
59       * Creates a new CD type
60       */
61      public CD(Message message) {
62          super(message);
63          init();
64      }
65  
66      private void init() {
67          data = new Type[6];    
68          data[0] = new WVI(getMessage());
69          data[1] = new WVS(getMessage());
70          data[2] = new CSU(getMessage());
71          data[3] = new CCP(getMessage());
72          data[4] = new NM(getMessage());
73          data[5] = new NR(getMessage());
74      }
75  
76  
77      /**
78       * Returns an array containing the data elements.
79       */
80      public Type[] getComponents() { 
81          return this.data; 
82      }
83  
84      /**
85       * Returns an individual data component.
86       *
87       * @param number The component number (0-indexed)
88       * @throws DataTypeException if the given element number is out of range.
89       */
90      public Type getComponent(int number) throws DataTypeException { 
91  
92          try { 
93              return this.data[number]; 
94          } catch (ArrayIndexOutOfBoundsException e) { 
95              throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
96          } 
97      } 
98  
99  
100     /**
101      * Returns Channel Identifier (component 1).  This is a convenience method that saves you from 
102      * casting and handling an exception.
103      */
104     public WVI getChannelIdentifier() {
105        return getTyped(0, WVI.class);
106     }
107 
108     
109     /**
110      * Returns Channel Identifier (component 1).  This is a convenience method that saves you from 
111      * casting and handling an exception.
112      */
113     public WVI getCd1_ChannelIdentifier() {
114        return getTyped(0, WVI.class);
115     }
116 
117 
118     /**
119      * Returns Waveform Source (component 2).  This is a convenience method that saves you from 
120      * casting and handling an exception.
121      */
122     public WVS getWaveformSource() {
123        return getTyped(1, WVS.class);
124     }
125 
126     
127     /**
128      * Returns Waveform Source (component 2).  This is a convenience method that saves you from 
129      * casting and handling an exception.
130      */
131     public WVS getCd2_WaveformSource() {
132        return getTyped(1, WVS.class);
133     }
134 
135 
136     /**
137      * Returns Channel Sensitivity and Units (component 3).  This is a convenience method that saves you from 
138      * casting and handling an exception.
139      */
140     public CSU getChannelSensitivityAndUnits() {
141        return getTyped(2, CSU.class);
142     }
143 
144     
145     /**
146      * Returns Channel Sensitivity and Units (component 3).  This is a convenience method that saves you from 
147      * casting and handling an exception.
148      */
149     public CSU getCd3_ChannelSensitivityAndUnits() {
150        return getTyped(2, CSU.class);
151     }
152 
153 
154     /**
155      * Returns Channel Calibration Parameters (component 4).  This is a convenience method that saves you from 
156      * casting and handling an exception.
157      */
158     public CCP getChannelCalibrationParameters() {
159        return getTyped(3, CCP.class);
160     }
161 
162     
163     /**
164      * Returns Channel Calibration Parameters (component 4).  This is a convenience method that saves you from 
165      * casting and handling an exception.
166      */
167     public CCP getCd4_ChannelCalibrationParameters() {
168        return getTyped(3, CCP.class);
169     }
170 
171 
172     /**
173      * Returns Channel Sampling Frequency (component 5).  This is a convenience method that saves you from 
174      * casting and handling an exception.
175      */
176     public NM getChannelSamplingFrequency() {
177        return getTyped(4, NM.class);
178     }
179 
180     
181     /**
182      * Returns Channel Sampling Frequency (component 5).  This is a convenience method that saves you from 
183      * casting and handling an exception.
184      */
185     public NM getCd5_ChannelSamplingFrequency() {
186        return getTyped(4, NM.class);
187     }
188 
189 
190     /**
191      * Returns Minimum and Maximum Data Values (component 6).  This is a convenience method that saves you from 
192      * casting and handling an exception.
193      */
194     public NR getMinimumAndMaximumDataValues() {
195        return getTyped(5, NR.class);
196     }
197 
198     
199     /**
200      * Returns Minimum and Maximum Data Values (component 6).  This is a convenience method that saves you from 
201      * casting and handling an exception.
202      */
203     public NR getCd6_MinimumAndMaximumDataValues() {
204        return getTyped(5, NR.class);
205     }
206 
207 
208 
209 }
210