DCMTK
Version 3.6.6
OFFIS DICOM Toolkit
|
Class managing the data from the Multi-Frame Functional Group Module. More...
Classes | |
class | ConcatenationInfo |
Helper class encapsulating concatenation information, including Concatenation Frame Offset Number, Concatenation UID, SOP Instance UID of Concatenation Source, In-concatenation Number, In-concatenation Total Number. More... | |
Public Member Functions | |
IODMultiFrameFGModule (OFshared_ptr< DcmItem > data, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODMultiFrameFGModule () | |
Constructor. | |
virtual | ~IODMultiFrameFGModule () |
Virtual destructor. | |
virtual OFString | getName () const |
Get name of the module ("MultiframeFunctionalGroupsModule") More... | |
virtual void | resetRules () |
Reset attribute rules to their default values. | |
virtual OFCondition | read (DcmItem &source, const OFBool clearOldData=OFTrue) |
Read attributes from given item into this class. More... | |
virtual OFCondition | write (DcmItem &destination) |
Write attributes from this class into given item. More... | |
virtual OFCondition | getInstanceNumber (Sint32 &value, const unsigned int pos=0) |
Get Instance Number. More... | |
virtual OFCondition | getContentDate (OFString &value, const signed long pos=0) |
Get Content Date. More... | |
virtual OFCondition | getContentTime (OFString &value, const signed long pos=0) |
Get Content Time. More... | |
virtual OFCondition | getNumberOfFrames (Sint32 &value, const unsigned int pos=0) |
Get Number of Frames. More... | |
virtual OFCondition | getRepresentativeFrameNumber (Uint16 &value, const unsigned int pos=0) |
Get Representative Frame Number. More... | |
virtual ConcatenationInfo & | getConcatenationInfo () |
Get Concatenation Information. More... | |
virtual OFCondition | setInstanceNumber (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Number. More... | |
virtual OFCondition | setContentDate (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Date. More... | |
virtual OFCondition | setContentTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Content Time. More... | |
virtual OFCondition | setNumberOfFrames (const Uint32 value) |
Set Number of Frames. More... | |
virtual OFCondition | setRepresentativeFrameNumber (const Uint16 value) |
Set Representative Frame Number. More... | |
virtual OFCondition | setConcatenationInfo (const ConcatenationInfo &concatenationInfo) |
Set concatenation information. More... | |
![]() | |
IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODModule () | |
Constructor. More... | |
IODModule (const IODModule &rhs) | |
Copy constructor, creates shallow copy. More... | |
IODModule & | operator= (const IODModule &rhs) |
Assignment operator, creates shallow copy. More... | |
~IODModule () | |
Desctructor. | |
![]() | |
IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL) | |
Constructor. More... | |
IODComponent (IODComponent *parent=NULL) | |
Constructor, creates rules and item from scratch. More... | |
IODComponent & | operator= (const IODComponent &rhs) |
Assignment operator, copies contained item and rule set from rhs to "this" attribute set. More... | |
IODComponent (const IODComponent &rhs) | |
Copy constructor, copies reference to contained item and rule set to "this" attribute set. More... | |
virtual | ~IODComponent () |
Virtual Destructor. | |
void | clearData () |
Clear all attributes from the data that are handled by this module. More... | |
virtual void | inventMissing () |
Set missing values by inventing "default values". More... | |
OFshared_ptr< IODRules > | getRules () |
Get rules handled by this module. More... | |
virtual void | makeOptional () |
Make component optional by turning all attributes requirement types of it to type 3. More... | |
DcmItem & | getData () |
Get the data handled by this module. More... | |
virtual OFCondition | check (const OFBool quiet=OFFalse) |
Check whether this component's data satisfies the underlying rules. More... | |
virtual int | compare (const IODComponent &rhs) const |
Comparison operator for IOD Components. More... | |
Private Attributes | |
ConcatenationInfo | m_ConcatenationInfo |
Concatenation Information. | |
Static Private Attributes | |
static const OFString | m_ModuleName |
Module name ("MultiframeFunctionalGroupsModule". | |
Additional Inherited Members | |
![]() | |
static OFCondition | read (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName) |
Static helper function that reads attributes from given item into destination item, as determined by the provided rules and component name. More... | |
static OFCondition | write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName) |
Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. More... | |
![]() | |
OFshared_ptr< DcmItem > | m_Item |
Shared pointer to the data handled by this class. More... | |
OFshared_ptr< IODRules > | m_Rules |
Rules describing the attributes governed by this class. | |
IODComponent * | m_Parent |
The parent component (may be NULL) of this class. | |
Class managing the data from the Multi-Frame Functional Group Module.
The actual functional groups are not included and can be interfaced by the FGInterface class in module "dcmfg".
IODMultiFrameFGModule::IODMultiFrameFGModule | ( | OFshared_ptr< DcmItem > | data, |
OFshared_ptr< IODRules > | rules | ||
) |
Constructor.
data | The item to be used for data storage. If NULL, the class creates an empty data container. |
rules | The rule set for this class. If NULL, the class creates one from scratch and adds its values. |
|
virtual |
Get Concatenation Information.
|
virtual |
Get Content Date.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Content Time.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Instance Number.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get name of the module ("MultiframeFunctionalGroupsModule")
Implements IODComponent.
|
virtual |
Get Number of Frames.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Representative Frame Number.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Read attributes from given item into this class.
source | The source to read from |
clearOldData | If OFTrue, old data is cleared before reading. Otherwise old data is overwritten (or amended) |
Reimplemented from IODComponent.
|
virtual |
Set concatenation information.
concatenationInfo | The concatenation info to set |
|
virtual |
Set Content Date.
value | Value to be stored |
checkValue | Check 'value' for conformance with VR (DA) and VM (1) if enabled |
|
virtual |
Set Content Time.
value | Value to be stored |
checkValue | Check 'value' for conformance with VR (TM) and VM (1) if enabled |
|
virtual |
Set Instance Number.
value | Value to be stored |
checkValue | Check 'value' for conformance with VR (IS) and VM (1) if enabled |
|
virtual |
Set Number of Frames.
value | Value to be stored |
|
virtual |
Set Representative Frame Number.
value | Value to be stored |
|
virtual |
Write attributes from this class into given item.
destination | The item to write to |
Reimplemented from IODComponent.