Odil
A C++11 library for the DICOM standard
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
odil::BasicDirectoryCreator Class Reference

Write a Basic Directory (i.e. DICOMDIR) object to the disk. More...

#include <BasicDirectoryCreator.h>

Public Types

typedef std::pair< Tag, int > RecordKey
 The tag and its associated type in the record. More...
 
typedef std::map< std::string, std::vector< RecordKey > > RecordKeyMap
 Map from a record type to the extra keys. More...
 

Public Member Functions

 BasicDirectoryCreator (std::string const &root="", std::vector< std::string > const &files=std::vector< std::string >(), RecordKeyMap const &extra_record_keys=RecordKeyMap(), Writer::ItemEncoding item_encoding=Writer::ItemEncoding::ExplicitLength)
 Constructor. More...
 
void operator() () const
 Create and write the Basic Directory. More...
 

Public Attributes

std::string root
 Root of the DICOM files and location of the output DICOMDIR file. More...
 
std::vector< std::string > files
 Path to the DICOM files, relative to root. More...
 
RecordKeyMap extra_record_keys
 User-defined record keys, classified by record type. More...
 
Writer::ItemEncoding item_encoding
 Encoding of sequence items, defaults to Writer::ItemEncoding::ExplicitLength. More...
 

Static Public Attributes

static RecordKeyMap const default_record_keys
 Default record keys, classified by record type. More...
 

Detailed Description

Write a Basic Directory (i.e. DICOMDIR) object to the disk.

Member Typedef Documentation

◆ RecordKey

The tag and its associated type in the record.

◆ RecordKeyMap

typedef std::map<std::string, std::vector<RecordKey> > odil::BasicDirectoryCreator::RecordKeyMap

Map from a record type to the extra keys.

Constructor & Destructor Documentation

◆ BasicDirectoryCreator()

odil::BasicDirectoryCreator::BasicDirectoryCreator ( std::string const &  root = "",
std::vector< std::string > const &  files = std::vector< std::string >(),
RecordKeyMap const &  extra_record_keys = RecordKeyMap(),
Writer::ItemEncoding  item_encoding = Writer::ItemEncoding::ExplicitLength 
)

Constructor.

Member Function Documentation

◆ operator()()

void odil::BasicDirectoryCreator::operator() ( ) const

Create and write the Basic Directory.

Member Data Documentation

◆ default_record_keys

RecordKeyMap const odil::BasicDirectoryCreator::default_record_keys
static

Default record keys, classified by record type.

◆ extra_record_keys

RecordKeyMap odil::BasicDirectoryCreator::extra_record_keys

User-defined record keys, classified by record type.

◆ files

std::vector<std::string> odil::BasicDirectoryCreator::files

Path to the DICOM files, relative to root.

The concatenation of root and each file must be a valid path.

◆ item_encoding

Writer::ItemEncoding odil::BasicDirectoryCreator::item_encoding

Encoding of sequence items, defaults to Writer::ItemEncoding::ExplicitLength.

◆ root

std::string odil::BasicDirectoryCreator::root

Root of the DICOM files and location of the output DICOMDIR file.

The concatenation of root and each file, as well as of root and "DICOMDIR" must be a valid path.


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