cdac.medinfo.sdk.dcm30_04.baselibs

Class RadiopharmaceuticalInformationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RadiopharmaceuticalInformationSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class RadiopharmaceuticalInformationSequenceItem
extends Item

This item class contains set,get and validate methods for attributes of Radiopharmaceutical Information Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
AdministrationRouteCodeSequence	getAdministrationRouteCodeSequence() Retrieves Sequence that identifies the administration route for the radiopharmaceutical.
CalibrationDataSequence	getCalibrationDataSequence() Retrieves sequence that contains calibration data..
RadionuclideCodeSequence	getRadionuclideCodeSequence() Retrieves pre-initialized object of Radionuclide Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getRadionuclideHalfLife() Retrieves The radionuclide half life, in seconds, that was used in the correction of this image.
java.lang.String	getRadionuclidePositronFraction() Retrieves The radionuclide positron fraction that was used in the correction of this image.
java.lang.String	getRadionuclideTotalDose() Retrieves Total amount of radionuclide injected.
java.lang.String	getRadiopharmaceutical() Retrieves Name of the radiopharmaceutical.
java.lang.String	getRadiopharmaceuticalAdministrationEventUID() Retrieves a UID that can be used to uniquely reference this signature.
RadiopharmaceuticalCodeSequence	getRadiopharmaceuticalCodeSequence() Retrieves pre-initialized object of Radiopharmaceutical Code Sequence.
java.lang.String	getRadiopharmaceuticalRoute() Retrieves Route of administration.
java.lang.String	getRadiopharmaceuticalSpecificActivity() Retrieves Radiopharmaceutical Specific Activity.
java.lang.String	getRadiopharmaceuticalStartTime() Retrieves Time of start of administration.
java.lang.String	getRadiopharmaceuticalStopTime() Retrieves Time of end of administration.
java.lang.String	getRadiopharmaceuticalVolume() Retrieves String value of Radiopharmaceutical Volume.
void	setRadionuclideHalfLife(java.lang.String strRadionuclideHalfLife) Sets The radionuclide half life, in seconds, that was used in the correction of this image.
void	setRadionuclidePositronFraction(java.lang.String strRadionuclidePositronFraction) Sets The radionuclide positron fraction that was used in the correction of this image.
void	setRadionuclideTotalDose(java.lang.String strRadionuclideTotalDose) Sets Total amount of radionuclide injected.
void	setRadiopharmaceutical(java.lang.String strRadiopharmaceutical) Sets Name of the radiopharmaceutical.
void	setRadiopharmaceuticalAdministrationEventUID(java.lang.String strRadiopharmaceuticalAdministrationEventUID) Sets a UID that can be used to uniquely reference this signature.
void	setRadiopharmaceuticalRoute(java.lang.String strRadiopharmaceuticalRoute) Sets Route of administration..
void	setRadiopharmaceuticalSpecificActivity(java.lang.String strRadiopharmaceuticalSpecificActivity) Sets The activity per unit mass of the radiopharmaceutical, in Bq/micromole, at the Radiopharmaceutical Start Time
void	setRadiopharmaceuticalStartTime(java.lang.String strRadiopharmaceuticalStartTime) Sets Time of start of administration..
void	setRadiopharmaceuticalStopTime(java.lang.String strRadiopharmaceuticalStopTime) Sets Time of end of administration.
void	setRadiopharmaceuticalVolume(java.lang.String strRadiopharmaceuticalVolume) Sets Volume of administered radiopharmaceutical in cubic cm.
boolean	validateForModule() Validates all the attributes in RadiopharmaceuticalInformationSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in RadiopharmaceuticalInformationSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

getRadionuclideCodeSequence

public RadionuclideCodeSequence getRadionuclideCodeSequence()

Retrieves pre-initialized object of Radionuclide Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

RadionuclideCodeSequence - instance of Radionuclide Code Sequence.

setRadiopharmaceuticalRoute

public void setRadiopharmaceuticalRoute(java.lang.String strRadiopharmaceuticalRoute)

Sets Route of administration..

Parameters:

strRadiopharmaceuticalRoute - String value of Radiopharmaceutical Route.

getRadiopharmaceuticalRoute

public java.lang.String getRadiopharmaceuticalRoute()

Retrieves Route of administration.

Returns:

String - value of Radiopharmaceutical Route.

getAdministrationRouteCodeSequence

public AdministrationRouteCodeSequence getAdministrationRouteCodeSequence()

Retrieves Sequence that identifies the administration route for the radiopharmaceutical.

Returns:

- instance of AdministrationRouteCodeSequence.

setRadiopharmaceuticalVolume

public void setRadiopharmaceuticalVolume(java.lang.String strRadiopharmaceuticalVolume)

Sets Volume of administered radiopharmaceutical in cubic cm.

Parameters:

strRadiopharmaceuticalVolume - String value of Radiopharmaceutical Volume.

getRadiopharmaceuticalVolume

public java.lang.String getRadiopharmaceuticalVolume()

Retrieves String value of Radiopharmaceutical Volume.

Returns:

String - value of Radiopharmaceutical Volume.

setRadiopharmaceuticalStartTime

public void setRadiopharmaceuticalStartTime(java.lang.String strRadiopharmaceuticalStartTime)

Sets Time of start of administration..

Parameters:

strRadiopharmaceuticalStartTime - String value of Radiopharmaceutical Start Time.

getRadiopharmaceuticalStartTime

public java.lang.String getRadiopharmaceuticalStartTime()

Retrieves Time of start of administration.

Returns:

String - value of Radiopharmaceutical Start Time.

setRadiopharmaceuticalStopTime

public void setRadiopharmaceuticalStopTime(java.lang.String strRadiopharmaceuticalStopTime)

Sets Time of end of administration.

Parameters:

strRadiopharmaceuticalStopTime - String value of Radiopharmaceutical Stop Time.

getRadiopharmaceuticalStopTime

public java.lang.String getRadiopharmaceuticalStopTime()

Retrieves Time of end of administration.

Returns:

- String - value of Radiopharmaceutical Stop Time.

setRadionuclideTotalDose

public void setRadionuclideTotalDose(java.lang.String strRadionuclideTotalDose)

Sets Total amount of radionuclide injected.

Parameters:

strRadionuclideTotalDose - String value of Radionuclide Total Dose

getRadionuclideTotalDose

public java.lang.String getRadionuclideTotalDose()

Retrieves Total amount of radionuclide injected.

Returns:

String - value of Radionuclide Total Dose

getCalibrationDataSequence

public CalibrationDataSequence getCalibrationDataSequence()

Retrieves sequence that contains calibration data..

Returns:

- instance of CalibrationDataSequence.

setRadiopharmaceutical

public void setRadiopharmaceutical(java.lang.String strRadiopharmaceutical)

Sets Name of the radiopharmaceutical.

Parameters:

strRadiopharmaceutical - String value of Radiopharmaceutical.

getRadiopharmaceutical

public java.lang.String getRadiopharmaceutical()

Retrieves Name of the radiopharmaceutical.

Returns:

strRadiopharmaceutical - String value of Radiopharmaceutical.

setRadiopharmaceuticalAdministrationEventUID

public void setRadiopharmaceuticalAdministrationEventUID(java.lang.String strRadiopharmaceuticalAdministrationEventUID)

Sets a UID that can be used to uniquely reference this signature.

Parameters:

strRadiopharmaceuticalAdministrationEventUID - String value of Digital Signature UID.

getRadiopharmaceuticalAdministrationEventUID

public java.lang.String getRadiopharmaceuticalAdministrationEventUID()

Retrieves a UID that can be used to uniquely reference this signature.

Returns:

String - value of Digital Signature UID.

setRadionuclideHalfLife

public void setRadionuclideHalfLife(java.lang.String strRadionuclideHalfLife)

Sets The radionuclide half life, in seconds, that was used in the correction of this image.

Parameters:

strRadionuclideHalfLife - String value of Radionuclide Half Life.

getRadionuclideHalfLife

public java.lang.String getRadionuclideHalfLife()

Retrieves The radionuclide half life, in seconds, that was used in the correction of this image.

Returns:

strRadiopharmaceutical - String value of Radionuclide Half Life.

setRadionuclidePositronFraction

public void setRadionuclidePositronFraction(java.lang.String strRadionuclidePositronFraction)

Sets The radionuclide positron fraction that was used in the correction of this image.

Parameters:

strRadionuclidePositronFraction - String value of Radionuclide Positron Fraction.

getRadionuclidePositronFraction

public java.lang.String getRadionuclidePositronFraction()

Retrieves The radionuclide positron fraction that was used in the correction of this image.

Returns:

strRadiopharmaceutical - String value of Radionuclide Positron Fraction.

setRadiopharmaceuticalSpecificActivity

public void setRadiopharmaceuticalSpecificActivity(java.lang.String strRadiopharmaceuticalSpecificActivity)

Sets The activity per unit mass of the radiopharmaceutical, in Bq/micromole, at the Radiopharmaceutical Start Time

Parameters:

strRadiopharmaceuticalSpecificActivity - String value of Radiopharmaceutical Specific Activity.

getRadiopharmaceuticalSpecificActivity

public java.lang.String getRadiopharmaceuticalSpecificActivity()

Retrieves Radiopharmaceutical Specific Activity.

Returns:

strRadiopharmaceutical - String value of Radiopharmaceutical Specific Activity.

getRadiopharmaceuticalCodeSequence

public RadiopharmaceuticalCodeSequence getRadiopharmaceuticalCodeSequence()

Retrieves pre-initialized object of Radiopharmaceutical Code Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

BeamLimitingDeviceSequence - instance of Radiopharmaceutical Code Sequence.