File: jDSRWaveformValue.java

package info (click to toggle)
dicomscope 3.6.0-28
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,256 kB
  • sloc: java: 22,911; cpp: 5,957; sh: 270; makefile: 45
file content (167 lines) | stat: -rw-r--r-- 5,774 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 *
 *  Copyright (C) 2000-2003, OFFIS and Institute for MicroTherapy
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  and
 *
 *    University of Witten/Herdecke
 *    Department of Radiology and MicroTherapy
 *    Institute for MicroTherapy
 *    Medical computer science
 *
 *    Universitaetsstrasse 142
 *    44799 Bochum, Germany
 *
 *    http://www.microtherapy.de/go/cs
 *    mailto:computer.science@microtherapy.de
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND THE INSTITUTE MAKES  NO
 *  WARRANTY REGARDING THE SOFTWARE, ITS PERFORMANCE, ITS MERCHANTABILITY
 *  OR FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES
 *  OR ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY
 *  AND PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Author :      $Author: kleber $
 *  Last update : $Date: 2001/06/06 10:32:30 $
 *  Revision :    $Revision: 1.1.1.1 $
 *  State:        $State: Exp $
*/


package J2Ci;


/**
 *  <em>jDSRWaveformValue</em> represents the relating C++ class
 *  DSRWaveformReferenceValue in Java.
 *
 *  @author 	Joerg Riesmeier
 */
public class jDSRWaveformValue
{
    /**
     * Constructor is disabled !!!
    */
    private jDSRWaveformValue()
    {
        // emtpy
    }


    /**
     * Constructor for attaching an existing C++ object. FOR INTERNAL USE ONLY!
     * @param attachAdr address of C++ object
    */
    public jDSRWaveformValue(long attachAdr)
    {
        cppClassAddress = attachAdr;
    }


    // --------------------- methods for C++ class binding ---------------------

    /**
     * Address of relating C++ object [for access to the DLL].
     * Never change manually!
    */
    private long cppClassAddress = (long) 0; // never change!



    // --------------------------- native methods ------------------------------

    /* --- Waveform Value --- */

    /** get SOP class UID
     ** @return current SOP class UID (might be invalid or an empty string)
     */
    public native String getSOPClassUID();

    /** get SOP class name.
     *  The SOP class name as defined in the OFFIS dcmtk is used if available,
     *  an empty string if the SOP class UID is also empty, the static string
     *  "unknown SOP class" plus the SOP class UID otherwise.
     ** @return name of the current SOP class (should never be null or empty)
     */
    public native String getSOPClassName();

    /** get SOP instance UID
     ** @return current SOP instance UID (might be invalid or an empty string)
     */
    public native String getSOPInstanceUID();

    /** set SOP class UID and SOP instance UID value.
     *  Before setting the values they are checked (non-empty UIDs).  Currently
     *  all waveform SOP classes that are defined in supplement 30 are allowed.
     *  If the value pair is invalid the current value pair is not replaced and
     *  remains unchanged.
     ** @param  sopClassUID     SOP class UID to be set
     *  @param  sopInstanceUID  SOP instance UID to be set
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    public native int setReference(String sopClassUID,
                                   String sopInstanceUID);

    /** clear the referenced channel list
     */
    public native void clearChannelList();

    /** get number of entries contained in the referenced channel list
     ** @return number of channels if any, 0 otherwise
     */
    public native int getNumberOfChannels();

    /** get copy of the specified entry from the referenced channel list
     ** @param  idx                   index of the entry to be returned (starting from 1)
     *  @param  multiplexGroupNumber  reference to variable where the multiplex group number
     *                                should be stored
     *  @param  channelNumber         reference to variable where the channel number should be
     *                                stored
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    public native int getChannel(int idx,
                                 jIntByRef multiplexGroupNumber,
                                 jIntByRef channelNumber);

    /** add entry to the referenced channel list.
     *  Please note that only channels are added that are not already contained in the list.
     ** @param  multiplexGroupNumber  multiplex group number to be added
     *  @param  channelNumber         channel number to be added
     */
    public native void addChannel(int multiplexGroupNumber,
                                  int channelNumber);

    /** remove entry from the referenced channel list
     ** @param  idx  index of the entry to be removed (starting from 1)
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    public native int removeChannel(int idx);

    /** check whether the waveform reference applies to a specific channel.
     *  The waveform reference applies to a channel if the list of referenced waveform
     *  channels is empty or the group/channel pair is part of the list.
     ** @param  multiplexGroupNumber  multiplex group number of the referenced channel
     *  @param  channelNumber         channel number of the referenced channel
     ** @return OFTrue if reference applies to the specified channel, OFFalse otherwise
     */
    public native boolean appliesToChannel(int multiplexGroupNumber,
                                           int channelNumber);
}


/*
 *  CVS Log
 *  $Log: jDSRWaveformValue.java,v $
 *  Revision 1.1.1.1  2001/06/06 10:32:30  kleber
 *  Init commit for DICOMscope 3.5
 *  Create new CVS
 *
 *
*/