GDCM: gdcm::Fragment Class Reference

GDCM 3.2.5

Public Member Functions | Friends | List of all members
gdcm::Fragment Class Reference

Class to represent a Fragment. More...

`#include <gdcmFragment.h>`

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

## Public Member Functions
| Fragment ()
VL | ComputeLength () const
VL | GetLength () const
template<typename TSwap>
std::istream & | Read (std::istream &is)
template<typename TSwap>
std::istream & | ReadBacktrack (std::istream &is)
template<typename TSwap>
std::istream & | ReadPreValue (std::istream &is)
template<typename TSwap>
std::istream & | ReadValue (std::istream &is)
template<typename TSwap>
std::ostream & | Write (std::ostream &os) const
Public Member Functions inherited from gdcm::DataElement
| DataElement (const DataElement &_val)
| DataElement (const Tag &t=Tag(0), const VL &vl=0, const VR &vr=VR::INVALID)
void | Clear ()
| Clear Data Element (make Value empty and invalidate Tag + VR).
void | Empty ()
| Make Data Element empty (no Value).
const ByteValue * | GetByteValue () const
template<typename TDE>
VL | GetLength () const
SequenceOfFragments * | GetSequenceOfFragments ()
const SequenceOfFragments * | GetSequenceOfFragments () const
Tag & | GetTag ()
const Tag & | GetTag () const
| Get Tag.
Value & | GetValue ()
Value const & | GetValue () const
| Set/Get Value (bytes array, SQ of items, SQ of fragments):
SmartPointer< SequenceOfItems > | GetValueAsSQ () const
VL & | GetVL ()
const VL & | GetVL () const
| Get VL.
VR const & | GetVR () const
bool | IsEmpty () const
| Check if Data Element is empty.
bool | IsUndefinedLength () const
| return if Value Length if of undefined length
bool | operator< (const DataElement &de) const
DataElement & | operator= (const DataElement &)=default
bool | operator== (const DataElement &de) const
template<typename TDE, typename TSwap>
std::istream & | Read (std::istream &is)
template<typename TDE, typename TSwap>
std::istream & | ReadOrSkip (std::istream &is, std::set< Tag > const &skiptags)
template<typename TDE, typename TSwap>
std::istream & | ReadPreValue (std::istream &is, std::set< Tag > const &skiptags)
template<typename TDE, typename TSwap>
std::istream & | ReadValue (std::istream &is, std::set< Tag > const &skiptags)
template<typename TDE, typename TSwap>
std::istream & | ReadValueWithLength (std::istream &is, VL &length, std::set< Tag > const &skiptags)
template<typename TDE, typename TSwap>
std::istream & | ReadWithLength (std::istream &is, VL &length)
void | SetByteValue (const char *array, VL length)
void | SetTag (const Tag &t)
void | SetValue (Value const &vl)
void | SetVL (const VL &vl)
void | SetVLToUndefined ()
void | SetVR (VR const &vr)
template<typename TDE, typename TSwap>
const std::ostream & | Write (std::ostream &os) const

## Friends
std::ostream & | operator<< (std::ostream &os, const Fragment &val)

## Additional Inherited Members
Protected Types inherited from gdcm::DataElement
typedef SmartPointer< Value > | ValuePtr
Protected Member Functions inherited from gdcm::DataElement
void | SetValueFieldLength (VL vl, bool readvalues)
Protected Attributes inherited from gdcm::DataElement
Tag | TagField
ValuePtr | ValueField
VL | ValueLengthField
VR | VRField

## Detailed Description

Class to represent a Fragment.

Examples
  DecompressImageMultiframe.cs, DecompressJPEGFile.cs, FixBrokenJ2K.cxx, FixJAIBugJPEGLS.cxx, and MpegVideoInfo.cs.

## Constructor & Destructor Documentation

## ◆ Fragment()

gdcm::Fragment::Fragment | ( |  | ) |
| inline

References gdcm::DataElement::DataElement().

Referenced by gdcm::BasicOffsetTable::BasicOffsetTable(), and operator<<.

## Member Function Documentation

## ◆ ComputeLength()

VL gdcm::Fragment::ComputeLength | ( |  | ) | const

## ◆ GetLength()

VL gdcm::Fragment::GetLength | ( |  | ) | const

## ◆ Read()

template<typename TSwap>

std::istream & gdcm::Fragment::Read | ( | std::istream & | is | ) |
| inline

References ReadPreValue(), and ReadValue().

Referenced by gdcm::SequenceOfFragments::ReadValue().

## ◆ ReadBacktrack()

template<typename TSwap>

std::istream & gdcm::Fragment::ReadBacktrack | ( | std::istream & | is | ) |
| inline

References gdcm_assert, gdcmErrorMacro, gdcmWarningMacro, gdcm::ParseException::SetLastElement(), gdcm::DataElement::TagField, gdcm::DataElement::ValueField, and gdcm::DataElement::ValueLengthField.

Referenced by gdcm::SequenceOfFragments::ReadValue().

## ◆ ReadPreValue()

template<typename TSwap>

std::istream & gdcm::Fragment::ReadPreValue | ( | std::istream & | is | ) |
| inline

References gdcm::DataElement::TagField, and gdcm::DataElement::ValueLengthField.

Referenced by Read().

## ◆ ReadValue()

template<typename TSwap>

std::istream & gdcm::Fragment::ReadValue | ( | std::istream & | is | ) |
| inline

References gdcmWarningMacro, gdcm::ParseException::SetLastElement(), gdcm::DataElement::ValueField, and gdcm::DataElement::ValueLengthField.

Referenced by Read().

## ◆ Write()

template<typename TSwap>

std::ostream & gdcm::Fragment::Write | ( | std::ostream & | os | ) | const
| inline

References gdcm::ByteValue::ComputeLength(), gdcm_assert, gdcm::DataElement::GetByteValue(), gdcm::ByteValue::GetLength(), gdcm::DataElement::IsEmpty(), gdcm::DataElement::TagField, gdcm::DataElement::ValueLengthField, gdcm::ByteValue::Write(), and gdcm::VL::Write().

## Friends And Related Symbol Documentation

## ◆ operator<<

std::ostream & operator<< | ( | std::ostream & | os,
|  | const Fragment & | val )
| friend

References Fragment(), operator<<, gdcm::DataElement::TagField, gdcm::DataElement::ValueField, and gdcm::DataElement::ValueLengthField.

Referenced by operator<<.

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

- gdcmFragment.h