DicomPackage Class

Summary: The Dicom Xmp package.

Module: aspose.imaging.xmp.schemas.dicom

Full Name: aspose.imaging.xmp.schemas.dicom.DicomPackage

Inheritance: IXmlValue, XmpPackage

Constructors

Name	Description
DicomPackage()	Initializes a new instance of the DicomPackage class.

Properties

Name	Type	Access	Description
count	int	r	Gets the XMP key count.
namespace_uri	string	r	Gets the namespace URI.
prefix	string	r	Gets the prefix.
xml_namespace	string	r	Gets the XML namespace.

Methods

Name	Description
add_value(key, value)	Adds the value to the specified key.
add_value(key, value)	Adds the value to the specified key.
clear()	Clears this instance.
contains_key(key)	Determines whether this collection specified key.
get_prop_value(key)	Gets the object with the specified key.
get_xml_value()	Converts XMP value to the XML representation.
remove(key)	Remove the value with the specified key.
set_equipment_institution(equipment_institution)	Sets the equipment institution.
set_equipment_manufacturer(equipment_manufacturer)	Sets the equipment manufacturer.
set_patient_birth_date(patient_birth_date)	Sets the patient’s birth date.
set_patient_id(patient_id)	Sets the patient’s ID.
set_patient_name(patient_name)	Sets the color mode.
set_patient_sex(patient_sex)	Sets the patient’s sex.
set_prop_value(key, value)	Gets or sets the object with the specified key.
set_series_date_time(series_date_time)	Sets the series date time.
set_series_description(series_description)	Sets series description.
set_series_modality(series_modality)	Sets the document series modality.
set_series_number(series_number)	Sets the series number.
set_study_date_time(study_date_time)	Sets the study DateTime.
set_study_description(study_description)	Sets the study description.
set_study_id(study_id)	Sets the study ID.
set_study_physician(study_physician)	Sets the study physician.
set_value(key, value)	Sets the value.
set_value(key, value)	Sets the value.
set_xmp_type_value(key, value)	Sets the XMP type value.
try_get_value(key, value)	Gets the value by the key.

Constructor: DicomPackage()

 DicomPackage() 

Initializes a new instance of the DicomPackage class.

Method: add_value(key, value)

 add_value(key, value) 

Adds the value to the specified key.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	string	The value to add to.

Method: add_value(key, value)

 add_value(key, value) 

Adds the value to the specified key.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	System.Object	The value to add to.

Method: contains_key(key)

 contains_key(key) 

Determines whether this collection specified key.

Parameters:

Parameter	Type	Description
key	string	The key to be checked.

Returns

Type	Description
bool	True if the contains the specified key; otherwise, False.

Method: get_prop_value(key)

 get_prop_value(key) 

Gets the object with the specified key.

Parameters:

Parameter	Type	Description
key	string	The key that identifies value.

Returns

Type	Description
System.Object	Returns the object with the specified key.

Method: get_xml_value()

 get_xml_value() 

Converts XMP value to the XML representation.

Returns

Type	Description
string	Returns the XMP value converted to the XML representation.

Method: remove(key)

 remove(key) 

Remove the value with the specified key.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with removed value.

Returns

Type	Description
bool	Returns true if the value with the specified key was removed.

Method: set_equipment_institution(equipment_institution)

 set_equipment_institution(equipment_institution) 

Sets the equipment institution.

Parameters:

Parameter	Type	Description
equipment_institution	string	The equipment institution.

Method: set_equipment_manufacturer(equipment_manufacturer)

 set_equipment_manufacturer(equipment_manufacturer) 

Sets the equipment manufacturer.

Parameters:

Parameter	Type	Description
equipment_manufacturer	string	The equipment manufacturer.

Method: set_patient_birth_date(patient_birth_date)

 set_patient_birth_date(patient_birth_date) 

Sets the patient’s birth date.

Parameters:

Parameter	Type	Description
patient_birth_date	string	The patient’s birth date.

Method: set_patient_id(patient_id)

 set_patient_id(patient_id) 

Sets the patient’s ID.

Parameters:

Parameter	Type	Description
patient_id	string	The patient’s ID.

Method: set_patient_name(patient_name)

 set_patient_name(patient_name) 

Sets the color mode.

Parameters:

Parameter	Type	Description
patient_name	string	The patient’s name.

Method: set_patient_sex(patient_sex)

 set_patient_sex(patient_sex) 

Sets the patient’s sex.

Parameters:

Parameter	Type	Description
patient_sex	string	The patient’s sex.

Method: set_prop_value(key, value)

 set_prop_value(key, value) 

Gets or sets the object with the specified key.

Parameters:

Parameter	Type	Description
key	string	The key that identifies value.
value	System.Object	The object with the specified key.

Method: set_series_date_time(series_date_time)

 set_series_date_time(series_date_time) 

Sets the series date time.

Parameters:

Parameter	Type	Description
series_date_time	string	The series date time.

Method: set_series_description(series_description)

 set_series_description(series_description) 

Sets series description.

Parameters:

Parameter	Type	Description
series_description	string	The series description.

Method: set_series_modality(series_modality)

 set_series_modality(series_modality) 

Sets the document series modality.

Parameters:

Parameter	Type	Description
series_modality	string	The series modality.

Method: set_series_number(series_number)

 set_series_number(series_number) 

Sets the series number.

Parameters:

Parameter	Type	Description
series_number	string	The series number.

Method: set_study_date_time(study_date_time)

 set_study_date_time(study_date_time) 

Sets the study DateTime.

Parameters:

Parameter	Type	Description
study_date_time	string	The studyDateTime.

Method: set_study_description(study_description)

 set_study_description(study_description) 

Sets the study description.

Parameters:

Parameter	Type	Description
study_description	string	The study description.

Method: set_study_id(study_id)

 set_study_id(study_id) 

Sets the study ID.

Parameters:

Parameter	Type	Description
study_id	string	The study ID.

Method: set_study_physician(study_physician)

 set_study_physician(study_physician) 

Sets the study physician.

Parameters:

Parameter	Type	Description
study_physician	string	The study physician.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	IXmlValue	The value to add to.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with added value.
value	IXmpType	The value to add to.

Method: set_xmp_type_value(key, value)

 set_xmp_type_value(key, value) 

Sets the XMP type value.

Parameters:

Parameter	Type	Description
key	string	The string representation of key that is identified with set value.
value	XmpTypeBase	The value to set to.

Method: try_get_value(key, value)

 try_get_value(key, value) 

Gets the value by the key.

Parameters:

Parameter	Type	Description
key	string	The XMP element key.
value	System.Object	The XMP value.

Returns

Type	Description
bool	True, if the contains the key; otherwise, False.