📄 dviface.h
字号:
* a different image or presentation state is loaded * (using loadPState or loadImage) or when resetPresentationState() is called. * @return reference to the current presentation state */ DVPresentationState& getCurrentPState() { return *pState; } /** returns a reference to the current structured report. * This reference will become invalid when the DVInterface object is deleted or * a different structured report is loaded (using loadStructuredReport). * @return reference to the current structured report */ DSRDocument& getCurrentReport() { return *pReport; } /** returns a reference to the print handler. * This reference remains valid as long as the DVInterface object exists. * @return reference to the current print handler */ DVPSStoredPrint& getPrintHandler() { return *pPrint; } /** resets the presentation state object to the status it had immediately after the * last successful operation of "loadImage" or "loadPState". A state can also explicitly * specified as such a "reset state" by using the method saveCurrentPStateForReset(). * Attention: The last reference returned by getCurrentPState() becomes invalid * when this method is called. * @return EC_Normal upon success, an error code otherwise. */ OFCondition resetPresentationState(); /** saves the current state of the presentation state object to be used for * resetPresentationState(). This is e.g. useful after registration of additional images * directly after a new images has been loaded. * @return EC_Normal upon success, an error code otherwise. */ OFCondition saveCurrentPStateForReset(); /** removes any shared or exclusive lock on the database. * This method should be called when a database transaction * (i.e. reading all studies, series, instances etc.) is finished. * As long as a lock exists on the database, no other application * (i.e. the network receiver) can add new images to the database. * This method also clears the index cache. * @return EC_Normal upon success, an error code otherwise. */ OFCondition releaseDatabase(); /** searches in the database for a DICOM instance with the given * study, series and instance UIDs and returns its pathname if found. * If the given instance is not found in the database, NULL is returned. * This method acquires a database lock which must be explicitly freed by the user. * @param studyUID the DICOM study instance UID * @param seriesUID the DICOM series instance UID * @param instanceUID the DICOM SOP instance UID * @return filename (path) if found, NULL otherwise */ const char *getFilename(const char *studyUID, const char *seriesUID, const char *instanceUID); /** returns the number of studies currently contained in the database. * This method acquires a database lock which must be explicitly freed by the user. * The number reported (returned) by this method remains valid as long * as the database lock remains active and no function modifying the database is called. * Functions that modify the database are: Storing new presentation states, * deleting data, modifying the 'reviewed' status flag of IODs. * @return number of studies in the database. */ Uint32 getNumberOfStudies(); /** selects the study with the given index in the database. * This method acquires a database lock which must be explicitly freed by the user. * The selection remains valid until the database lock is removed or the database * is modified (see comments for getNumberOfStudies). * Implicitly the first series and first instance within this study is selected, too. * @param idx index to be selected, must be < getNumberOfStudies() * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectStudy(Uint32 idx); /** selects the study with the given UID in the database. * This method acquires a database lock which must be explicitly freed by the user. * The selection remains valid until the database lock is removed or the database * is modified (see comments for getNumberOfStudies). * Implicitly the first series and first instance within this study is selected, too. * @param studyUID the DICOM study instance UID * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectStudy(const char *studyUID); /** returns the review status of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * Implicitly the first instance within this series is selected, too. * @return study review status */ DVIFhierarchyStatus getStudyStatus() ; /** returns the Study Instance UID of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Study Instance UID or NULL if absent or not selected. */ const char *getStudyUID(); /** returns the Study Description of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Study Description or NULL if absent or not selected. */ const char *getStudyDescription(); /** returns the Study Date of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Study Date or NULL if absent or not selected. */ const char *getStudyDate(); /** returns the Study Time of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Study Time or NULL if absent or not selected. */ const char *getStudyTime(); /** returns the Referring Physicians Name of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Referring Physicians Name or NULL if absent or not selected. */ const char *getReferringPhysiciansName(); /** returns the Accession Number of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Accession Number or NULL if absent or not selected. */ const char *getAccessionNumber(); /** returns the Name Of Physicians Reading Study of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * @return Name Of Physicians Reading Study or NULL if absent or not selected. */ const char *getNameOfPhysiciansReadingStudy(); /** returns the Patient Name of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient Name or NULL if absent or not selected. */ const char *getPatientName(); /** returns the Patient ID of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient ID or NULL if absent or not selected. */ const char *getPatientID(); /** returns the Patient Birth Date of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient Birth Date or NULL if absent or not selected. */ const char *getPatientBirthDate(); /** returns the Patient Sex of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient Sex or NULL if absent or not selected. */ const char *getPatientSex(); /** returns the Patient Birth Time of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient Birth Time or NULL if absent or not selected. */ const char *getPatientBirthTime(); /** returns the Other Patient Names of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Other Patient Names or NULL if absent or not selected. */ const char *getOtherPatientNames(); /** returns the Other Patient ID of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Other Patient ID or NULL if absent or not selected. */ const char *getOtherPatientID(); /** returns the Patient Ethnic Group of the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * Note: Since the database uses the Study Root model, patient data appears * on the study level. * This method acquires a database lock which must be explicitly freed by the user. * @return Patient Ethnic Group or NULL if absent or not selected. */ const char *getEthnicGroup(); /** returns the number of series within the currently selected study. * May be called only if a valid study selection exists - see selectStudy(). * This method acquires a database lock which must be explicitly freed by the user. * See the comments for getNumberOfStudies() about the validity period * of the returned number. * @return number of series in the current study. */ Uint32 getNumberOfSeries(); /** selects the series with the given index within the currently selected study. * This method acquires a database lock which must be explicitly freed by the user. * The selection remains valid until the database lock is removed or the database * is modified (see comments for getNumberOfStudies). * @param idx index to be selected, must be < getNumberOfSeries() * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectSeries(Uint32 idx); /** selects the series with the given UID within the currently selected study. * This method acquires a database lock which must be explicitly freed by the user. * The selection remains valid until the database lock is removed or the database * is modified (see comments for getNumberOfStudies). * @param seriesUID series instance UID of the image * @return EC_Normal upon success, an error code otherwise.
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -