cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ContrastBolusModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ContrastBolusModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ContrastBolusModule
extends Module

This class specifies the Attributes that describe the contrast /bolus used in the acquisition of the Image.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
ContrastBolusModule(IDataSet objIDataSet) Creates Contarst/Bolus Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
ContrastBolusAdministrationRouteSequence	getContrastBolusAdministrationRouteSequence() This method provides the pre-initialized object of Contrast Bolus Administration Route Sequence.
java.lang.String	getContrastBolusAgent() Retrieves the Agent of Contrast/Bolus.
ContrastBolusAgentSequence	getContrastBolusAgentSequence() This method provides the pre-initialized object of Contrast Bolus Agent Sequence.
java.lang.String	getContrastBolusIngredient() Retrieves the Contrast/Bolus Ingredient.
java.lang.String	getContrastBolusIngredientConcentration() Retrieves the Contrast/Bolus Ingredient Concentration.
java.lang.String	getContrastBolusRoute() Retrieves the Route of Contrast/Bolus.
java.lang.String	getContrastBolusStartTime() Retrieves the Start time of Contrast/Bolus.
java.lang.String	getContrastBolusStopTime() Retrieves the Stop time of Contrast/Bolus.
java.lang.String	getContrastBolusTotalDose() Retrieves the Total dose of Contrast/Bolus.
java.lang.String	getContrastBolusVolume() Retrieves the Volume of Contrast/Bolus.
java.lang.String[]	getContrastFlowDuration() Retrieves the Duration of Contrast Flow.
java.lang.String[]	getContrastFlowRate() Retrieves the Rate of Contrast Flow.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setContrastBolusAgent(java.lang.String strContrastBolusAgent) The method is used to set Contrast or bolus agent The function accepts a String Value strContrastBolusAgent and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastBolusIngredient(EnumContrastBolusIngredient enumContrastBolusIngredient) The method is used to set active ingredient of agent.
void	setContrastBolusIngredientConcentration(java.lang.String strContrastBolusIngredientConcentration) The method is used to set milligrams of active ingredient per milliliter of (diluted) agent The function accepts a String Value as the strContrastBolusIngredientConcentration and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastBolusRoute(java.lang.String strContrastBolusRoute) The method is used to set administration route of contrast agent The function accepts a String Value as the strContrastBolusRoute and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastBolusStartTime(java.lang.String strContrastBolusStartTime) The method is used to set time of start of injection The function accepts a String Value as the strContrastBolusStartTime and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastBolusStopTime(java.lang.String strContrastBolusStopTime) The method is used to set time of end of contrast injection The function accepts a String Value as the strContrastBolusStopTime and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastBolusTotalDose(java.lang.String strContrastBolusTotalDose) The method is used to set total amount in milliliters of the undiluted contrast agent.
void	setContrastBolusVolume(java.lang.String strContrastBolusVolume) The method is used to set volume injected in milliliters of diluted contrast agent The function accepts a String Value as the strContrastBolusVolume and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContrastFlowDuration(java.lang.String[] arrStrContrastFlowDuration) This method is used to set duration(s) of injection(s) in seconds.
void	setContrastFlowRate(java.lang.String[] arrStrContrastFlowRate) This method is used to set rate(s) of injection(s) in milliliters/sec The function accepts a String ARRAY Value arrStrContrastFlowRate and creates the DE based on the transfer syntax and populates the DE with right values.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

ContrastBolusModule

public ContrastBolusModule(IDataSet objIDataSet)

Creates Contarst/Bolus Module with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setContrastBolusAgent

public void setContrastBolusAgent(java.lang.String strContrastBolusAgent)

The method is used to set Contrast or bolus agent The function accepts a String Value strContrastBolusAgent and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusAgent - :String value of Contrast or bolus agent.

setContrastBolusRoute

public void setContrastBolusRoute(java.lang.String strContrastBolusRoute)

The method is used to set administration route of contrast agent The function accepts a String Value as the strContrastBolusRoute and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusRoute - : administration route of contrast agent.

setContrastBolusVolume

public void setContrastBolusVolume(java.lang.String strContrastBolusVolume)

The method is used to set volume injected in milliliters of diluted contrast agent The function accepts a String Value as the strContrastBolusVolume and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusVolume - : Volume injected in milliliters of diluted contrast agent

setContrastBolusStartTime

public void setContrastBolusStartTime(java.lang.String strContrastBolusStartTime)

The method is used to set time of start of injection The function accepts a String Value as the strContrastBolusStartTime and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusStartTime - : Time of start of injection.

setContrastBolusStopTime

public void setContrastBolusStopTime(java.lang.String strContrastBolusStopTime)

The method is used to set time of end of contrast injection The function accepts a String Value as the strContrastBolusStopTime and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusStopTime - : Time of end of contrast injection.

setContrastBolusTotalDose

public void setContrastBolusTotalDose(java.lang.String strContrastBolusTotalDose)

The method is used to set total amount in milliliters of the undiluted contrast agent. The function accepts a String Value as the strContrastBolusTotalDose and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusTotalDose - : total amount in milliliters of the undiluted contrast agent.

setContrastFlowRate

public void setContrastFlowRate(java.lang.String[] arrStrContrastFlowRate)

This method is used to set rate(s) of injection(s) in milliliters/sec The function accepts a String ARRAY Value arrStrContrastFlowRate and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrContrastFlowRate - :rate(s) of injection(s) in milliliters/sec

setContrastFlowDuration

public void setContrastFlowDuration(java.lang.String[] arrStrContrastFlowDuration)

This method is used to set duration(s) of injection(s) in seconds. Each Contrast Flow Duration value shall correspond to a value of Contrast Flow Rate The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrContrastFlowDuration - :duration(s) of injection(s) in seconds.

setContrastBolusIngredient

public void setContrastBolusIngredient(EnumContrastBolusIngredient enumContrastBolusIngredient)

The method is used to set active ingredient of agent. The function accepts a String Value as the strContrastBolusIngredient and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap Defined Terms IODINE GADOLINIUM CARBON DIOXIDE BARIUM

Parameters:

enumContrastBolusIngredient - the enum contrast bolus ingredient

setContrastBolusIngredientConcentration

public void setContrastBolusIngredientConcentration(java.lang.String strContrastBolusIngredientConcentration)

The method is used to set milligrams of active ingredient per milliliter of (diluted) agent The function accepts a String Value as the strContrastBolusIngredientConcentration and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strContrastBolusIngredientConcentration - : milligrams of active ingredient per milliliter of (diluted) agent

getContrastBolusAgentSequence

public ContrastBolusAgentSequence getContrastBolusAgentSequence()

This method provides the pre-initialized object of Contrast Bolus Agent Sequence.

Returns:

- object of Contrast Bolus Agent 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

getContrastBolusAdministrationRouteSequence

public ContrastBolusAdministrationRouteSequence getContrastBolusAdministrationRouteSequence()

This method provides the pre-initialized object of Contrast Bolus Administration Route Sequence.

Returns:

- object of Contributing Equipment 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

getContrastBolusAgent

public java.lang.String getContrastBolusAgent()

Retrieves the Agent of Contrast/Bolus.

Returns:

- the Agent of Contrast/Bolus

getContrastBolusRoute

public java.lang.String getContrastBolusRoute()

Retrieves the Route of Contrast/Bolus.

Returns:

- the Route of Contrast/Bolus

getContrastBolusVolume

public java.lang.String getContrastBolusVolume()

Retrieves the Volume of Contrast/Bolus.

Returns:

- the Volume of Contrast/Bolus

getContrastBolusStartTime

public java.lang.String getContrastBolusStartTime()

Retrieves the Start time of Contrast/Bolus.

Returns:

- the Start time of Contrast/Bolus

getContrastBolusStopTime

public java.lang.String getContrastBolusStopTime()

Retrieves the Stop time of Contrast/Bolus.

Returns:

- the Stop time of Contrast/Bolus

getContrastBolusTotalDose

public java.lang.String getContrastBolusTotalDose()

Retrieves the Total dose of Contrast/Bolus.

Returns:

- the Total dose of Contrast/Bolus

getContrastFlowRate

public java.lang.String[] getContrastFlowRate()

Retrieves the Rate of Contrast Flow.

Returns:

- the Rate of Contrast Flow

getContrastFlowDuration

public java.lang.String[] getContrastFlowDuration()

Retrieves the Duration of Contrast Flow.

Returns:

- the Duration of Contrast Flow

getContrastBolusIngredient

public java.lang.String getContrastBolusIngredient()

Retrieves the Contrast/Bolus Ingredient.

Returns:

- the Contrast/Bolus Ingredient

getContrastBolusIngredientConcentration

public java.lang.String getContrastBolusIngredientConcentration()

Retrieves the Contrast/Bolus Ingredient Concentration.

Returns:

- the Contrast/Bolus Ingredient Concentration

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

- custom collection containing the list of DataElements belonging to the CT Image Module