GDCM 3.0.24
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
gdcm::Writer Class Reference

Writer ala DOM (Document Object Model) More...

#include <gdcmWriter.h>

Inheritance diagram for gdcm::Writer:
[legend]
Collaboration diagram for gdcm::Writer:
[legend]

Public Member Functions

 Writer ()
 
virtual ~Writer ()
 
void CheckFileMetaInformationOff ()
 
void CheckFileMetaInformationOn ()
 
FileGetFile ()
 
void SetCheckFileMetaInformation (bool b)
 Undocumented function, do not use (= leave default)
 
void SetFile (const File &f)
 Set/Get the DICOM file (DataSet + Header)
 
void SetFileName (const char *filename_native)
 Set the filename of DICOM file to write:
 
void SetStream (std::ostream &output_stream)
 Set user ostream buffer.
 
virtual bool Write ()
 Main function to tell the writer to write.
 

Protected Member Functions

bool GetCheckFileMetaInformation () const
 
std::ostream * GetStreamPtr () const
 
void SetWriteDataSetOnly (bool b)
 

Protected Attributes

std::ofstream * Ofstream
 
std::ostream * Stream
 

Friends

class StreamImageWriter
 

Detailed Description

Writer ala DOM (Document Object Model)

This class is a non-validating writer, it will only performs well- formedness check only.

Detailed description here To avoid GDCM being yet another broken DICOM lib we try to be user level and avoid writing illegal stuff (odd length, non-zero value for Item start/end length ...) Therefore you cannot (well unless you are really smart) write DICOM with even length tag. All the checks are consider basics:

Warning
gdcm::Writer cannot write a DataSet if no SOP Instance UID (0008,0018) is found, unless a DICOMDIR is being written out
See also
Reader DataSet File
Examples
BasicAnonymizer.cs, ChangePrivateTags.cxx, ChangeSequenceUltrasound.cxx, Cleaner.cs, ClinicalTrialAnnotate.cxx, ClinicalTrialIdentificationWorkflow.cs, CreateFakeRTDOSE.cxx, CreateJPIPDataSet.cxx, DeriveSeries.cxx, DuplicatePCDE.cxx, EncapsulateFileInRawData.cxx, Extracting_All_Resolution.cxx, Fake_Image_Using_Stream_Image_Writer.cxx, FixBrokenJ2K.cxx, FixJAIBugJPEGLS.cxx, FixOrientation.cxx, GenAllVR.cxx, GenFakeIdentifyFile.cxx, GenLongSeqs.cxx, GenSeqs.cxx, GenerateDICOMDIR.cs, HelloWorld.cxx, LargeVRDSExplicit.cxx, MakeTemplate.cxx, ManipulateFile.cs, NewSequence.cs, PatchFile.cxx, QIDO-RS.cxx, ReformatFile.cs, StreamImageReaderTest.cxx, pmsct_rgb1.cxx, and rle2img.cxx.

Constructor & Destructor Documentation

◆ Writer()

gdcm::Writer::Writer ( )

◆ ~Writer()

virtual gdcm::Writer::~Writer ( )
virtual

Member Function Documentation

◆ CheckFileMetaInformationOff()

void gdcm::Writer::CheckFileMetaInformationOff ( )
inline

◆ CheckFileMetaInformationOn()

void gdcm::Writer::CheckFileMetaInformationOn ( )
inline

◆ GetCheckFileMetaInformation()

bool gdcm::Writer::GetCheckFileMetaInformation ( ) const
inlineprotected

◆ GetFile()

File & gdcm::Writer::GetFile ( )
inline

◆ GetStreamPtr()

std::ostream * gdcm::Writer::GetStreamPtr ( ) const
inlineprotected

◆ SetCheckFileMetaInformation()

void gdcm::Writer::SetCheckFileMetaInformation ( bool  b)
inline

Undocumented function, do not use (= leave default)

Examples
GenAllVR.cxx, GenFakeIdentifyFile.cxx, and PatchFile.cxx.

◆ SetFile()

void gdcm::Writer::SetFile ( const File f)
inline

◆ SetFileName()

void gdcm::Writer::SetFileName ( const char *  filename_native)

◆ SetStream()

void gdcm::Writer::SetStream ( std::ostream &  output_stream)
inline

Set user ostream buffer.

◆ SetWriteDataSetOnly()

void gdcm::Writer::SetWriteDataSetOnly ( bool  b)
inlineprotected

◆ Write()

virtual bool gdcm::Writer::Write ( )
virtual

Friends And Related Symbol Documentation

◆ StreamImageWriter

friend class StreamImageWriter
friend

Member Data Documentation

◆ Ofstream

std::ofstream* gdcm::Writer::Ofstream
protected

◆ Stream

std::ostream* gdcm::Writer::Stream
protected

The documentation for this class was generated from the following file: