DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SegmentDescriptionMacro Class Reference

Class representing the Segment Description Macro. More...

Public Member Functions

 SegmentDescriptionMacro ()
 Constructor.
 
virtual ~SegmentDescriptionMacro ()
 Virtual destructor, frees memory.
 
virtual void clearData ()
 Clear all data.
 
virtual OFCondition read (DcmItem &item)
 Read class data from given item. More...
 
virtual OFCondition write (DcmItem &item)
 Writes the data from this class to given item. More...
 
virtual OFCondition getSegmentLabel (OFString &value, const signed long pos=0)
 Get Segment Label. More...
 
virtual OFCondition getSegmentDescription (OFString &value, const signed long pos=0)
 Get Segment Description. More...
 
virtual
DcmSegTypes::E_SegmentAlgoType 
getSegmentAlgorithmType ()
 Get Segment Algorithm Type. More...
 
virtual GeneralAnatomyMacrogetGeneralAnatomyCode ()
 Get reference to General Anatomy Code. More...
 
virtual CodeSequenceMacrogetSegmentedPropertyCategoryCode ()
 Get Reference to Segmented Property Category Code. More...
 
virtual CodeSequenceMacrogetSegmentedPropertyTypeCode ()
 Get Reference to Segmented Property Type Code. More...
 
virtual OFVector
< CodeSequenceMacro * > & 
getSegmentedPropertyTypeModifier ()
 Get Reference to Segmented Property Type Modifier Codes. More...
 
virtual OFCondition setSegmentLabel (const OFString &value, const OFBool checkValue=OFTrue)
 Set Segment Label. More...
 
virtual OFCondition setSegmentDescription (const OFString &value, const OFBool checkValue=OFTrue)
 Set Segment Description. More...
 
virtual OFCondition setSegmentAlgorithmType (const DcmSegTypes::E_SegmentAlgoType value)
 Set Segment Algorithm Type. More...
 

Protected Member Functions

virtual OFCondition readSegmentAlgorithmType (DcmItem &item)
 Read Segment Algorithm Type from given item. More...
 
virtual OFCondition writeSegmentAlgorithmType (DcmItem &item)
 Write Segment Algorithm Type to given item. More...
 

Private Attributes

DcmLongString m_SegmentLabel
 Segment Number: (LO, VM 1, Type 1)
 
DcmShortText m_SegmentDescription
 Segment Description: (ST, 1, Type 3)
 
DcmSegTypes::E_SegmentAlgoType m_SegmentAlgorithmType
 Segment Algorithm Type: (CS, 1, Type 1)
 
GeneralAnatomyMacro m_GeneralAnatomyCode
 General Anatomy Mandatory Macro.
 
CodeSequenceMacro m_SegmentedPropertyCategoryCode
 Segment Property Category Code (SQ, 1, 1) Baseline CID 7150.
 
SegmentedPropertyTypeCodeItem m_SegmentedPropertyType
 Segmented Property Type Code.
 

Detailed Description

Class representing the Segment Description Macro.

Member Function Documentation

virtual GeneralAnatomyMacro& SegmentDescriptionMacro::getGeneralAnatomyCode ( )
virtual

Get reference to General Anatomy Code.

Returns
Reference to General Anatomy Code
virtual DcmSegTypes::E_SegmentAlgoType SegmentDescriptionMacro::getSegmentAlgorithmType ( )
virtual

Get Segment Algorithm Type.

Returns
The algorithm type
virtual OFCondition SegmentDescriptionMacro::getSegmentDescription ( OFString value,
const signed long  pos = 0 
)
virtual

Get Segment Description.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual CodeSequenceMacro& SegmentDescriptionMacro::getSegmentedPropertyCategoryCode ( )
virtual

Get Reference to Segmented Property Category Code.

Returns
Reference to Segmented Property Category Code
virtual CodeSequenceMacro& SegmentDescriptionMacro::getSegmentedPropertyTypeCode ( )
virtual

Get Reference to Segmented Property Type Code.

Returns
Reference to Segmented Property Type Code
virtual OFVector<CodeSequenceMacro*>& SegmentDescriptionMacro::getSegmentedPropertyTypeModifier ( )
virtual

Get Reference to Segmented Property Type Modifier Codes.

Returns
Reference to Segmented Property Type Modifier Codes
virtual OFCondition SegmentDescriptionMacro::getSegmentLabel ( OFString value,
const signed long  pos = 0 
)
virtual

Get Segment Label.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition SegmentDescriptionMacro::read ( DcmItem item)
virtual

Read class data from given item.

Parameters
itemThe item to read from
Returns
EC_Normal if reading was successful, error otherwise
virtual OFCondition SegmentDescriptionMacro::readSegmentAlgorithmType ( DcmItem item)
protectedvirtual

Read Segment Algorithm Type from given item.

Parameters
itemThe item to read from
Returns
EC_Normal if reading was successful, error otherwise
virtual OFCondition SegmentDescriptionMacro::setSegmentAlgorithmType ( const DcmSegTypes::E_SegmentAlgoType  value)
virtual

Set Segment Algorithm Type.

Parameters
valueValue to be set
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition SegmentDescriptionMacro::setSegmentDescription ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Segment Description.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value'. Not evaluated (here for consistency with other setter functions).
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition SegmentDescriptionMacro::setSegmentLabel ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Segment Label.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition SegmentDescriptionMacro::write ( DcmItem item)
virtual

Writes the data from this class to given item.

Parameters
itemThe item to write to
Returns
EC_Normal if writing was successful, error otherwise
virtual OFCondition SegmentDescriptionMacro::writeSegmentAlgorithmType ( DcmItem item)
protectedvirtual

Write Segment Algorithm Type to given item.

Parameters
itemThe item to write to
Returns
EC_Normal if writing was successful, error otherwise

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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8