vega::dicom::FileMeta Class Reference

A class which encapsulates the file meta portion of a DICOM file. More...

#include <vega/dicom/file_meta.h>

Classes
class	InvalidFileMeta

Public Member Functions
	FileMeta ()
	FileMeta (const SOPClass &sop_class)
	FileMeta (const SOPClass &sop_class, const UID &media_storage_instance_uid)
	FileMeta (Reader &reader)
const TransferSyntax &	transfer_syntax () const
void	set_transfer_syntax (const TransferSyntax &other)
Endian	transfer_syntax_endian () const
bool	transfer_syntax_vr_explicit () const
std::shared_ptr< const DataSet >	data_set () const
const SOPClass &	sop_class () const
const UID &	media_storage_instance_uid () const
bool	present () const
size_t	write (std::shared_ptr< Writer > writer)

Detailed Description

A class which encapsulates the file meta portion of a DICOM file.

This class represents the file meta part of a DICOM file (the set of tags with group 0x0002). It has a data_set() method which contains the DataElements that make up the file meta.

Constructor & Destructor Documentation

FileMeta() [1/4]

vega::dicom::FileMeta::FileMeta

(

)

Creates a blank FileMeta object.

FileMeta() [2/4]

vega::dicom::FileMeta::FileMeta

(

const SOPClass &

sop_class

)

Creates a blank FileMeta object with the given sop_class and a random media storage SOP instance UID.

Parameters

sop_class

represents the type of DICOM file and has tag (0x0002,0x0002).

FileMeta() [3/4]

vega::dicom::FileMeta::FileMeta	(	const SOPClass &	sop_class,
		const UID &	media_storage_instance_uid
	)

Creates a blank FileMeta object with the given sop_class and media_storage_instance_uid.

Parameters

sop_class	represents the type of DICOM file and has tag (0x0002,0x0002).
media_storage_instance_uid	is the media storage SOP instance UID with tag (0x0002,0x0003).

FileMeta() [4/4]

vega::dicom::FileMeta::FileMeta

(

Reader &

reader

)

Read existing FileMeta data from a Reader object currently positioned at the start of the file meta (after the "DICM" characters).

Member Function Documentation

data_set()

std::shared_ptr<const DataSet> vega::dicom::FileMeta::data_set

(

)

const

Returns

a DataSet which contains all the DataElements that make up the file meta.

media_storage_instance_uid()

const UID& vega::dicom::FileMeta::media_storage_instance_uid

(

)

const

Returns

The media storage SOP instance UID with tag (0x0002,0x0003) for this FileMeta.

present()

bool vega::dicom::FileMeta::present

(

)

const

Returns

true if there exists some DataElements in this FileMeta.

set_transfer_syntax()

void vega::dicom::FileMeta::set_transfer_syntax

(

const TransferSyntax &

other

)

Parameters

The	TransferSyntax to set for this FileMeta.

sop_class()

const SOPClass& vega::dicom::FileMeta::sop_class

(

)

const

Returns

The media storage SOP class with tag (0x0002,0x0002) for this FileMeta.

transfer_syntax()

const TransferSyntax& vega::dicom::FileMeta::transfer_syntax

(

)

const

Returns

The TransferSyntax of this FileMeta.

transfer_syntax_endian()

Endian vega::dicom::FileMeta::transfer_syntax_endian

(

)

const

Returns

The Endianness of the DICOM file defined by the transfer syntax.

transfer_syntax_vr_explicit()

bool vega::dicom::FileMeta::transfer_syntax_vr_explicit

(

)

const

Returns

a boolean which is true if the transfer syntax is VR explicit, or false if VR implicit.

write()

size_t vega::dicom::FileMeta::write

(

std::shared_ptr< Writer >

writer

)

Writes this FileMeta data (the DataSet) to the provided Writer class starting from its current position.

---

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

• include/vega/dicom/file_meta.h