GDCM  2.4.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
gdcm::FileMetaInformation Class Reference

Class to represent a File Meta Information. More...

#include <gdcmFileMetaInformation.h>

Inheritance diagram for gdcm::FileMetaInformation:
Inheritance graph
[legend]
Collaboration diagram for gdcm::FileMetaInformation:
Collaboration graph
[legend]

Public Member Functions

 FileMetaInformation ()
 
 FileMetaInformation (FileMetaInformation const &fmi)
 
 ~FileMetaInformation ()
 
void FillFromDataSet (DataSet const &ds)
 Construct a FileMetaInformation from an already existing DataSet: More...
 
const TransferSyntaxGetDataSetTransferSyntax () const
 
VL GetFullLength () const
 
MediaStorage GetMediaStorage () const
 
std::string GetMediaStorageAsString () const
 
TransferSyntax::NegociatedType GetMetaInformationTS () const
 
const PreambleGetPreamble () const
 Get Preamble. More...
 
PreambleGetPreamble ()
 
void Insert (const DataElement &de)
 
bool IsValid () const
 
std::istream & Read (std::istream &is)
 Read. More...
 
std::istream & ReadCompat (std::istream &is)
 
void Replace (const DataElement &de)
 
void SetDataSetTransferSyntax (const TransferSyntax &ts)
 
void SetPreamble (const Preamble &p)
 
std::ostream & Write (std::ostream &os) const
 Write. More...
 
- Public Member Functions inherited from gdcm::DataSet
ConstIterator Begin () const
 
Iterator Begin ()
 
void Clear ()
 
template<typename TDE >
unsigned int ComputeGroupLength (Tag const &tag) const
 
ConstIterator End () const
 
Iterator End ()
 
bool FindDataElement (const PrivateTag &t) const
 Look up if private tag 't' is present in the dataset: More...
 
bool FindDataElement (const Tag &t) const
 
const DataElementFindNextDataElement (const Tag &t) const
 
const DataElementGetDataElement (const Tag &t) const
 
const DataElementGetDataElement (const PrivateTag &t) const
 Return the dataelement. More...
 
const DataElementSetGetDES () const
 
DataElementSetGetDES ()
 
template<typename TDE >
VL GetLength () const
 
MediaStorage GetMediaStorage () const
 
std::string GetPrivateCreator (const Tag &t) const
 Return the private creator of the private tag 't': More...
 
void Insert (const DataElement &de)
 
bool IsEmpty () const
 Returns if the dataset is empty. More...
 
const DataElementoperator() (uint16_t group, uint16_t element) const
 
DataSetoperator= (DataSet const &val)
 
const DataElementoperator[] (const Tag &t) const
 
void Print (std::ostream &os, std::string const &indent="") const
 
template<typename TDE , typename TSwap >
std::istream & Read (std::istream &is)
 
template<typename TDE , typename TSwap >
std::istream & ReadNested (std::istream &is)
 
template<typename TDE , typename TSwap >
std::istream & ReadSelectedPrivateTags (std::istream &is, const std::set< PrivateTag > &tags, bool readvalues=true)
 
template<typename TDE , typename TSwap >
std::istream & ReadSelectedPrivateTagsWithLength (std::istream &is, const std::set< PrivateTag > &tags, VL &length, bool readvalues=true)
 
template<typename TDE , typename TSwap >
std::istream & ReadSelectedTags (std::istream &is, const std::set< Tag > &tags, bool readvalues=true)
 
template<typename TDE , typename TSwap >
std::istream & ReadSelectedTagsWithLength (std::istream &is, const std::set< Tag > &tags, VL &length, bool readvalues=true)
 
template<typename TDE , typename TSwap >
std::istream & ReadUpToTag (std::istream &is, const Tag &t, std::set< Tag > const &skiptags)
 
template<typename TDE , typename TSwap >
std::istream & ReadUpToTagWithLength (std::istream &is, const Tag &t, std::set< Tag > const &skiptags, VL &length)
 
template<typename TDE , typename TSwap >
std::istream & ReadWithLength (std::istream &is, VL &length)
 
SizeType Remove (const Tag &tag)
 Completely remove a dataelement from the dataset. More...
 
void Replace (const DataElement &de)
 Replace a dataelement with another one. More...
 
void ReplaceEmpty (const DataElement &de)
 Only replace a DICOM attribute when it is missing or empty. More...
 
SizeType Size () const
 
template<typename TDE , typename TSwap >
std::ostream const & Write (std::ostream &os) const
 

Static Public Member Functions

static void AppendImplementationClassUID (const char *imp)
 
static const char * GetImplementationClassUID ()
 
static const char * GetImplementationVersionName ()
 
static const char * GetSourceApplicationEntityTitle ()
 
static void SetImplementationClassUID (const char *imp)
 Override the GDCM default values: More...
 
static void SetImplementationVersionName (const char *version)
 
static void SetSourceApplicationEntityTitle (const char *title)
 

Protected Member Functions

void ComputeDataSetMediaStorageSOPClass ()
 
void ComputeDataSetTransferSyntax ()
 
void Default ()
 
template<typename TSwap >
std::istream & ReadCompatInternal (std::istream &is)
 
- Protected Member Functions inherited from gdcm::DataSet
Tag ComputeDataElement (const PrivateTag &t) const
 
const DataElementGetDEEnd () const
 
void InsertDataElement (const DataElement &de)
 

Static Protected Member Functions

static const char * GetFileMetaInformationVersion ()
 
static const char * GetGDCMImplementationClassUID ()
 
static const char * GetGDCMImplementationVersionName ()
 
static const char * GetGDCMSourceApplicationEntityTitle ()
 

Protected Attributes

MediaStorage::MSType DataSetMS
 
TransferSyntax DataSetTS
 
TransferSyntax::NegociatedType MetaInformationTS
 

Friends

std::ostream & operator<< (std::ostream &_os, const FileMetaInformation &_val)
 

Additional Inherited Members

- Public Types inherited from gdcm::DataSet
typedef DataElementSet::const_iterator ConstIterator
 
typedef std::set< DataElementDataElementSet
 
typedef DataElementSet::iterator Iterator
 
typedef DataElementSet::size_type SizeType
 

Detailed Description

Class to represent a File Meta Information.

FileMetaInformation is a Explicit Structured Set. Whenever the file contains an ImplicitDataElement DataSet, a conversion will take place.

Definition: The File Meta Information includes identifying information on the encapsulated Data Set. This header consists of a 128 byte File Preamble, followed by a 4 byte DICOM prefix, followed by the File Meta Elements shown in Table 7.1-1. This header shall be present in every DICOM file.

See also
Writer Reader
Examples:
GenAllVR.cxx, GenFakeIdentifyFile.cxx, LargeVRDSExplicit.cxx, and ReadAndDumpDICOMDIR.cxx.

Constructor & Destructor Documentation

gdcm::FileMetaInformation::FileMetaInformation ( )
gdcm::FileMetaInformation::~FileMetaInformation ( )
gdcm::FileMetaInformation::FileMetaInformation ( FileMetaInformation const &  fmi)
inline

Member Function Documentation

static void gdcm::FileMetaInformation::AppendImplementationClassUID ( const char *  imp)
static
void gdcm::FileMetaInformation::ComputeDataSetMediaStorageSOPClass ( )
protected
void gdcm::FileMetaInformation::ComputeDataSetTransferSyntax ( )
protected
void gdcm::FileMetaInformation::Default ( )
protected
void gdcm::FileMetaInformation::FillFromDataSet ( DataSet const &  ds)

Construct a FileMetaInformation from an already existing DataSet:

const TransferSyntax& gdcm::FileMetaInformation::GetDataSetTransferSyntax ( ) const
inline
static const char* gdcm::FileMetaInformation::GetFileMetaInformationVersion ( )
staticprotected
VL gdcm::FileMetaInformation::GetFullLength ( ) const
inline

References gdcm::VL::GetLength().

static const char* gdcm::FileMetaInformation::GetGDCMImplementationClassUID ( )
staticprotected
static const char* gdcm::FileMetaInformation::GetGDCMImplementationVersionName ( )
staticprotected
static const char* gdcm::FileMetaInformation::GetGDCMSourceApplicationEntityTitle ( )
staticprotected
static const char* gdcm::FileMetaInformation::GetImplementationClassUID ( )
static
static const char* gdcm::FileMetaInformation::GetImplementationVersionName ( )
static
MediaStorage gdcm::FileMetaInformation::GetMediaStorage ( ) const
std::string gdcm::FileMetaInformation::GetMediaStorageAsString ( ) const
TransferSyntax::NegociatedType gdcm::FileMetaInformation::GetMetaInformationTS ( ) const
inline
const Preamble& gdcm::FileMetaInformation::GetPreamble ( ) const
inline

Get Preamble.

Referenced by gdcm::operator<<().

Preamble& gdcm::FileMetaInformation::GetPreamble ( )
inline
static const char* gdcm::FileMetaInformation::GetSourceApplicationEntityTitle ( )
static
void gdcm::FileMetaInformation::Insert ( const DataElement de)
inline
bool gdcm::FileMetaInformation::IsValid ( ) const
inline
std::istream& gdcm::FileMetaInformation::Read ( std::istream &  is)

Read.

std::istream& gdcm::FileMetaInformation::ReadCompat ( std::istream &  is)
template<typename TSwap >
std::istream& gdcm::FileMetaInformation::ReadCompatInternal ( std::istream &  is)
protected
void gdcm::FileMetaInformation::Replace ( const DataElement de)
inline
void gdcm::FileMetaInformation::SetDataSetTransferSyntax ( const TransferSyntax ts)
static void gdcm::FileMetaInformation::SetImplementationClassUID ( const char *  imp)
static

Override the GDCM default values:

static void gdcm::FileMetaInformation::SetImplementationVersionName ( const char *  version)
static
void gdcm::FileMetaInformation::SetPreamble ( const Preamble p)
inline
static void gdcm::FileMetaInformation::SetSourceApplicationEntityTitle ( const char *  title)
static
std::ostream& gdcm::FileMetaInformation::Write ( std::ostream &  os) const

Write.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _os,
const FileMetaInformation _val 
)
friend

Member Data Documentation

MediaStorage::MSType gdcm::FileMetaInformation::DataSetMS
protected

Referenced by FileMetaInformation().

TransferSyntax gdcm::FileMetaInformation::DataSetTS
protected

Referenced by FileMetaInformation().

TransferSyntax::NegociatedType gdcm::FileMetaInformation::MetaInformationTS
protected

Referenced by FileMetaInformation().


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

Generated on Fri Sep 25 2015 17:58:30 for GDCM by doxygen 1.8.9.1
SourceForge.net Logo