DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes
DRTDigitalSignaturesSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTDigitalSignaturesSequence::Item:

List of all members.

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 Item (const Item &copy)
 copy constructor
virtual ~Item ()
 destructor
Itemoperator= (const Item &copy)
 assigment operator
void clear ()
 clear all internal member variables
OFBool isEmpty ()
 check if item is empty
OFBool isValid () const
 check if item is valid, i.e. not the empty default item
OFCondition read (DcmItem &item)
 read elements from sequence item
OFCondition write (DcmItem &item)
 write elements to sequence item
OFCondition getCertificateOfSigner (Uint8 *&value, unsigned long *count=NULL) const
 get CertificateOfSigner (0400,0115)
OFCondition getCertificateType (OFString &value, const signed long pos=0) const
 get CertificateType (0400,0110)
OFCondition getCertifiedTimestamp (Uint8 *&value, unsigned long *count=NULL) const
 get CertifiedTimestamp (0400,0310)
OFCondition getCertifiedTimestampType (OFString &value, const signed long pos=0) const
 get CertifiedTimestampType (0400,0305)
OFCondition getDigitalSignatureDateTime (OFString &value, const signed long pos=0) const
 get DigitalSignatureDateTime (0400,0105)
OFCondition getDigitalSignatureUID (OFString &value, const signed long pos=0) const
 get DigitalSignatureUID (0400,0100)
OFCondition getMACIDNumber (Uint16 &value, const unsigned long pos=0) const
 get MACIDNumber (0400,0005)
OFCondition getSignature (Uint8 *&value, unsigned long *count=NULL) const
 get Signature (0400,0120)
DRTDigitalSignaturePurposeCodeSequencegetDigitalSignaturePurposeCodeSequence ()
 get DigitalSignaturePurposeCodeSequence (0400,0401)
const
DRTDigitalSignaturePurposeCodeSequence
getDigitalSignaturePurposeCodeSequence () const
 get DigitalSignaturePurposeCodeSequence (0400,0401)
OFCondition setCertificateOfSigner (const Uint8 *value, const unsigned long count)
 set CertificateOfSigner (0400,0115)
OFCondition setCertificateType (const OFString &value, const OFBool check=OFTrue)
 set CertificateType (0400,0110)
OFCondition setCertifiedTimestamp (const Uint8 *value, const unsigned long count)
 set CertifiedTimestamp (0400,0310)
OFCondition setCertifiedTimestampType (const OFString &value, const OFBool check=OFTrue)
 set CertifiedTimestampType (0400,0305)
OFCondition setDigitalSignatureDateTime (const OFString &value, const OFBool check=OFTrue)
 set DigitalSignatureDateTime (0400,0105)
OFCondition setDigitalSignatureUID (const OFString &value, const OFBool check=OFTrue)
 set DigitalSignatureUID (0400,0100)
OFCondition setMACIDNumber (const Uint16 value, const unsigned long pos=0)
 set MACIDNumber (0400,0005)
OFCondition setSignature (const Uint8 *value, const unsigned long count)
 set Signature (0400,0120)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmOtherByteOtherWord CertificateOfSigner
 CertificateOfSigner (0400,0115) vr=OB, vm=1, type=1.
DcmCodeString CertificateType
 CertificateType (0400,0110) vr=CS, vm=1, type=1.
DcmOtherByteOtherWord CertifiedTimestamp
 CertifiedTimestamp (0400,0310) vr=OB, vm=1, type=3.
DcmCodeString CertifiedTimestampType
 CertifiedTimestampType (0400,0305) vr=CS, vm=1, type=1C.
DcmDateTime DigitalSignatureDateTime
 DigitalSignatureDateTime (0400,0105) vr=DT, vm=1, type=1.
DRTDigitalSignaturePurposeCodeSequence DigitalSignaturePurposeCodeSequence
 DigitalSignaturePurposeCodeSequence (0400,0401) vr=SQ, vm=1, type=3.
DcmUniqueIdentifier DigitalSignatureUID
 DigitalSignatureUID (0400,0100) vr=UI, vm=1, type=1.
DcmUnsignedShort MACIDNumber
 MACIDNumber (0400,0005) vr=US, vm=1, type=1.
DcmOtherByteOtherWord Signature
 Signature (0400,0120) vr=OB, vm=1, type=1.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTDigitalSignaturesSequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

OFCondition DRTDigitalSignaturesSequence::Item::getCertificateOfSigner ( Uint8 *&  value,
unsigned long *  count = NULL 
) const

get CertificateOfSigner (0400,0115)

Parameters:
valuereference to variable in which the value should be stored
countstores number of items in the result array (if not NULL)
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getCertificateType ( OFString value,
const signed long  pos = 0 
) const

get CertificateType (0400,0110)

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:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getCertifiedTimestamp ( Uint8 *&  value,
unsigned long *  count = NULL 
) const

get CertifiedTimestamp (0400,0310)

Parameters:
valuereference to variable in which the value should be stored
countstores number of items in the result array (if not NULL)
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getCertifiedTimestampType ( OFString value,
const signed long  pos = 0 
) const

get CertifiedTimestampType (0400,0305)

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:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getDigitalSignatureDateTime ( OFString value,
const signed long  pos = 0 
) const

get DigitalSignatureDateTime (0400,0105)

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:
status, EC_Normal if successful, an error code otherwise

get DigitalSignaturePurposeCodeSequence (0400,0401)

Returns:
reference to sequence element

get DigitalSignaturePurposeCodeSequence (0400,0401)

Returns:
const reference to sequence element
OFCondition DRTDigitalSignaturesSequence::Item::getDigitalSignatureUID ( OFString value,
const signed long  pos = 0 
) const

get DigitalSignatureUID (0400,0100)

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:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getMACIDNumber ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get MACIDNumber (0400,0005)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::getSignature ( Uint8 *&  value,
unsigned long *  count = NULL 
) const

get Signature (0400,0120)

Parameters:
valuereference to variable in which the value should be stored
countstores number of items in the result array (if not NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

check if item is empty

Returns:
OFTrue if item is empty, OFFalse otherwise

check if item is valid, i.e. not the empty default item

Returns:
OFTrue if item is valid, OFFalse otherwise
Item& DRTDigitalSignaturesSequence::Item::operator= ( const Item copy)

assigment operator

Parameters:
copyitem object to be copied

read elements from sequence item

Parameters:
itemreference to DICOM sequence item from which the elements should be read
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setCertificateOfSigner ( const Uint8 *  value,
const unsigned long  count 
)

set CertificateOfSigner (0400,0115)

Parameters:
valuearray value to be set (data is copied)
countnumber of items in the array
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setCertificateType ( const OFString value,
const OFBool  check = OFTrue 
)

set CertificateType (0400,0110)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setCertifiedTimestamp ( const Uint8 *  value,
const unsigned long  count 
)

set CertifiedTimestamp (0400,0310)

Parameters:
valuearray value to be set (data is copied)
countnumber of items in the array
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setCertifiedTimestampType ( const OFString value,
const OFBool  check = OFTrue 
)

set CertifiedTimestampType (0400,0305)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setDigitalSignatureDateTime ( const OFString value,
const OFBool  check = OFTrue 
)

set DigitalSignatureDateTime (0400,0105)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DT) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setDigitalSignatureUID ( const OFString value,
const OFBool  check = OFTrue 
)

set DigitalSignatureUID (0400,0100)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (UI) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setMACIDNumber ( const Uint16  value,
const unsigned long  pos = 0 
)

set MACIDNumber (0400,0005)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDigitalSignaturesSequence::Item::setSignature ( const Uint8 *  value,
const unsigned long  count 
)

set Signature (0400,0120)

Parameters:
valuearray value to be set (data is copied)
countnumber of items in the array
Returns:
status, EC_Normal if successful, an error code otherwise

write elements to sequence item

Parameters:
itemreference to DICOM sequence item to which the elements should be written
Returns:
status, EC_Normal if successful, an error code otherwise

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027