/usr/include/dcmtk/dcmiod/modsynchronisation.h is in libdcmtk-dev 3.6.2-3build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | /*
*
* Copyright (C) 2015-2017, Open Connections GmbH
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation are maintained by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmiod
*
* Author: Michael Onken
*
* Purpose: Class for managing the Synchronization Module
*
*/
#ifndef MODSYNCHRONIZATION_H
#define MODSYNCHRONIZATION_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofoption.h"
#include "dcmtk/dcmiod/modbase.h"
/** Class representing the Synchronization Module:
*
* Synchronization Frame of Reference UID: (UI, 1, 1)
* Synchronization Trigger: (CS, 1, 1)
* Trigger Source or Type: (LO, 1, 3)
* Synchronization Channel: (US, 2, 1C)
* Acquisition Time Synchronized: (CS, 1, 1)
* Time Source: (SH, 1, 3)
* Time Distribution Protocol: (CS, 1, 3)
* NTP Source Address (LO, 1, 3)
*/
class DCMTK_DCMIOD_EXPORT IODSynchronizationModule : public IODModule
{
public:
/** Constructor
* @param item The item to be used for data storage. If NULL, the
* class creates an empty data container.
* @param rules The rule set for this class. If NULL, the class creates
* one from scratch and adds its values.
*/
IODSynchronizationModule(OFshared_ptr<DcmItem> item,
OFshared_ptr<IODRules> rules);
/** Constructor
*/
IODSynchronizationModule();
/** Destructor
*/
virtual ~IODSynchronizationModule();
/** Resets rules to their original values
*/
virtual void resetRules();
/** Get name of module
* @return Name of the module ("SynchronizationModule")
*/
virtual OFString getName() const;
/** Get Synchronization Frame of Reference UID
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getSynchronizationFrameOfReferenceUID(OFString& value,
const signed long pos = 0) const;
/** Get Synchronization Trigger
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getSynchronizationTrigger(OFString& value,
const signed long pos = 0) const;
/** Get Trigger Source or Type
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getTriggerSourceOrType(OFString& value,
const signed long pos = 0) const;
/** Get Synchronization Channel
* @param value Reference to variable in which the value should be stored
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getSynchronizationChannel(OFVector<Uint16>& value) const;
/** Get Acquisition Time Synchronized
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getAcquisitionTimeSynchronized(OFString& value,
const signed long pos = 0) const;
/** Get Time Source
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getTimeSource(OFString& value,
const signed long pos = 0) const;
/** Get Time Distribution Protocol
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getTimeDistributionProtocol(OFString& value,
const signed long pos = 0) const;
/** Get NTP Source Address
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getNTPSourceAddress(OFString& value,
const signed long pos = 0) const;
/** Set Synchronization Frame of Reference UID
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (UI) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setSynchronizationFrameofReferenceUID(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Synchronization Trigger
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setSynchronizationTrigger(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Trigger Source or Type
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (LO) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setTriggerSourceOrType(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Synchronization Channel
* @param value Value to be set
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setSynchronizationChannel(const OFPair<Uint16, Uint16> &value,
const OFBool checkValue = OFTrue);
/** Set Acquisition Time Synchronized
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setAcquisitionTimeSynchronized(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Time Source
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (SH) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setTimeSource(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Time Distribution Protocol
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setTimeDistributionProtocol(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set NTP Source Address
* @param value Value to be set
* @param checkValue Check 'value' for conformance with VR (LO) and VM (1)
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setNTPSourceAddress(const OFString &value,
const OFBool checkValue = OFTrue);
protected:
/** Check whether given string is a valid value for attribute
* Acquisition Time Synchronized
* @param value The value to check
* @return OFTrue if value is valid for this attribute, OFFalse otherwise
*/
virtual OFBool isValidAcquisitionTimeSynchronized(const OFString& value);
/** Check whether given string is a valid value for attribute
* Time Distribution Protocol
* @param value The value to check
* @return OFTrue if value is valid for this attribute, OFFalse otherwise
*/
virtual OFBool isValidTimeDistributionProtocol(const OFString& value);
/** Check whether given string is a valid value for attribute
* Synchronization Trigger
* @param value The value to check
* @return OFTrue if value is valid for this attribute, OFFalse otherwise
*/
virtual OFBool isValidSynchronizationTrigger(const OFString& value);
private:
/// Module name "SynchronizationModule"
static const OFString m_ModuleName;
};
#endif // MODSYNCHRONIZATION_H
|