📄 dviface.h
字号:
*/ OFCondition selectSeries(const char *seriesUID); /** returns the Series Instance UID of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Instance UID or NULL if absent or not selected. */ const char *getSeriesUID(); /** returns the review status of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return series review status */ DVIFhierarchyStatus getSeriesStatus(); /** returns the type of all instances within the currently selected series. * DICOM series always contain a single modality only, if not the modality of * the first examined instance (which is no image) is used (e.g. PresentationState). * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return instance type */ DVPSInstanceType getSeriesType(); /** returns the type of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return instance type */ DVPSInstanceType getInstanceType(); /** returns the Series Number of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Number or NULL if absent or not selected. */ const char *getSeriesNumber(); /** returns the Series Date of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Date or NULL if absent or not selected. */ const char *getSeriesDate(); /** returns the Series Time of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Time or NULL if absent or not selected. */ const char *getSeriesTime(); /** returns the Series Description of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Description or NULL if absent or not selected. */ const char *getSeriesDescription(); /** returns the Series Performing Physicians Name of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Performing Physicians Name or NULL if absent or not selected. */ const char *getSeriesPerformingPhysiciansName(); /** returns the Series Protocol Name of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Protocol Name or NULL if absent or not selected. */ const char *getSeriesProtocolName(); /** returns the Series Operators Name of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Series Operators Name or NULL if absent or not selected. */ const char *getSeriesOperatorsName(); /** returns the Modality of the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * This method acquires a database lock which must be explicitly freed by the user. * @return Modality or NULL if absent or not selected. */ const char *getModality(); /** returns the number of instances (IODs) within the currently selected series. * May be called only if a valid series selection exists - see selectSeries(). * 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 instances in the current series. */ Uint32 getNumberOfInstances(); /** selects the instance with the given index within the currently selected series. * 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 < getNumberOfInstances() * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectInstance(Uint32 idx); /** selects the instance with the given UID within the currently selected series. * 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 instanceUID SOP instance UID of the instance * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectInstance(const char *instanceUID); /** selects the instance with the given UID and SOP class over all studies and series. * Please note that in worst case all studies, series and instances are examined. * 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 instanceUID SOP instance UID of the instance * @param sopClassUID SOP class UID of the instance (might be NULL to be not compared) * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectInstance(const char *instanceUID, const char *sopClassUID); /** selects the instance with the given UIDs. * 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 studyUID study instance UID of the instance * @param seriesUID series instance UID of the instance * @param instanceUID SOP instance UID of the instance * @return EC_Normal upon success, an error code otherwise. */ OFCondition selectInstance(const char *studyUID, const char *seriesUID, const char *instanceUID); /** returns the SOP class UID of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return SOP Instance UID or NULL if absent or not selected. */ const char *getSOPClassUID(); /** returns the SOP Instance UID of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return SOP Instance UID or NULL if absent or not selected. */ const char *getInstanceUID(); /** returns the Image Number of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return Image Number or NULL if absent or not selected. */ const char *getImageNumber(); /** returns the Filename of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return Filename or NULL if absent or not selected. */ const char *getFilename(); /** returns the review status of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return instance review status */ DVIFhierarchyStatus getInstanceStatus() ; /** returns the escription of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return Instance Description or NULL if absent or not selected. */ const char *getInstanceDescription(); /** returns the Presentation Label of the currently selected instance. * May be called only if a valid instance selection exists - see selectInstance(). * This method acquires a database lock which must be explicitly freed by the user. * @return Presentation Label or NULL if absent or not selected. */ const char *getPresentationLabel(); /* methods modifying the database */ /** modifies the review flag for one instance in the database, which is set to * 'reviewed' state (DVIF_objectIsNotNew). The status of the corresponding series * and study is updated automatically. * This method acquires a database lock which must be explicitly freed by the user. * The database is modified - any study, series or instance selection * and the number of studies, series and instances reported will become invalid since * other processes may modify the database before the exclusive lock is granted to this method. * @param studyUID study instance UID of the reviewed instance * @param seriesUID series instance UID of the reviewed instance * @param instanceUID SOP instance UID of the reviewed instance * @return EC_Normal upon success, an error code otherwise. */ OFCondition instanceReviewed(const char *studyUID, const char *seriesUID, const char *instanceUID); /** deletes the given instance from the database. If the corresponding DICOM file * resides in the same directory as the index file, it is also removed. * This method acquires a database lock which must be explicitly freed by the user. * The database is modified - any study, series or instance selection * and the number of studies, series and instances reported will become invalid since * other processes may modify the database before the exclusive lock is granted to this method. * @param studyUID study instance UID of the instance to be deleted * @param seriesUID series instance UID of the instance to be deleted * @param instanceUID SOP instance UID of the instance to be deleted * @return EC_Normal upon success, an error code otherwise. */ OFCondition deleteInstance(const char *studyUID, const char *seriesUID, const char *instanceUID); /** deletes the given series from the database. Any of the corresponding DICOM files * residing in the same directory as the index file are also removed. * This method acquires a database lock which must be explicitly freed by the user. * The database is modified - any study, series or instance selection * and the number of studies, series and instances reported will become invalid since * other processes may modify the database before the exclusive lock is granted to this method. * @param studyUID study instance UID of the series to be deleted * @param seriesUID series instance UID of the series to be deleted * @return EC_Normal upon success, an error code otherwise. */ OFCondition deleteSeries(const char *studyUID, const char *seriesUID); /** deletes the given study from the database. Any of the corresponding DICOM files * residing in the same directory as the index file are also removed. * This method acquires a database lock which must be explicitly freed by the user. * The database is modified - any study, series or instance selection * and the number of studies, series and instances reported will become invalid since * other processes may modify the database before the exclusive lock is granted to this method. * @param studyUID study instance UID of the study to be deleted * @return EC_Normal upon success, an error code otherwise. */ OFCondition deleteStudy(const char *studyUID); /* here follow the Network interface methods */ /** starts the network receiver processes (Storage Service Class SCPs). * The receiver processes will wait for incoming DICOM associations, receive images * and presentation states. Data will be stored in file and registered in the * database index file. Attention: Successful return of this method is no guarantee * that the network receiver has successfully started, because certain errors * (i.e. incorrect settings in the config file) will only be noted in the network
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -