cdac.medinfo.sdk.dcm30_04.baselibs

Class GeneralContributingSourcesMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.GeneralContributingSourcesMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class GeneralContributingSourcesMacro
extends Macro

This class contains the Macro that contains IOD Attributes that describe the general characteristics of the contributing sources used to create a new SOPInstance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeneralContributingSourcesMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
GeneralContributingSourcesMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
GeneralContributingSourcesMacro(IItem objItem) This constructor constructs a Macro with the specified Item
GeneralContributingSourcesMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDatetime() Retrieves the Date and Time of Acquisition
java.lang.String	getAcquisitionProtocolName() Return user-defined label identifier for AcquisitionProtocolName.
ContributingSOPInstancesReferenceSequence	getContributingSOPInstancesReferenceSequence() Retrieves pre-initialized object of Contributing SOP InstancesReference 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	getDeviceSerialNumber() Retrieves Manufacturer's serial number of the equipment used for beam delivery.
java.lang.String	getManufacturer() Retrieves Manufacturer of the equipment used for beam delivery.
java.lang.String	getManufacturersModelName() Retrieves Manufacturer's model name of the equipment used for beam delivery.
OperatorIdentificationSequence	getOperatorIdentificationSequence() Retrieves pre-initialized object of Operator Identification 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[]	getOperatorsName() Retrieves Name of operator.
PerformedProtocolCodeSequence	getPerformedProtocolCodeSequence() Retrieves pre-initialized object of Performed Protocol 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	getProtocolName() Return User-defined description of the conditions under which the Series was performed.
java.lang.String[]	getSoftwareVersions() Retrieves Manufacturer�s designation of the software version of the equipment that contributed to the composite instance.
java.lang.String	getStationName() Retrieves User defined name identifying the machine that contributed to the composite instance.
void	setAcquisitionDatetime(java.lang.String strAcquisitionDatetime) Sets the date and time the acquisition of data that resulted in this image started.
void	setAcquisitionProtocolName(java.lang.String strAcquisitionProtocolName) Sets Acquisition Protocol Name.
void	setDeviceSerialNumber(java.lang.String strDeviceSerialNumber) Sets Manufacturer's serial number of the equipment used for beam delivery.
void	setManufacturer(java.lang.String strManufacturer) Sets the Manufacturer of the equipment used for beam delivery..
void	setManufacturersModelName(java.lang.String strManufacturersModelName)
void	setOperatorsName(java.lang.String[] arrStrOperatorsName) Sets the Name of operator.
void	setProtocolName(java.lang.String StrProtocolName) Sets attribute identifies User-defined description of the conditions under which the Series was performed.
void	setSoftwareVersions(java.lang.String[] strSoftwareVersions) Sets Manufacturer�s designation of the software version of the equipment that contributed to the composite instance.
void	setStationName(java.lang.String strStationName) Sets User defined name identifying the machine that contributed to the composite instance.
boolean	validate() Validates all the attributes in GeneralContributingSourcesMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in GeneralContributingSourcesMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in GeneralContributingSourcesMacro that are present in the DataSet

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

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralContributingSourcesMacro

public GeneralContributingSourcesMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

GeneralContributingSourcesMacro

public GeneralContributingSourcesMacro(IDataSet objDataSet,
                               IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

GeneralContributingSourcesMacro

public GeneralContributingSourcesMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

GeneralContributingSourcesMacro

public GeneralContributingSourcesMacro(IItem objItem,
                               IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in GeneralContributingSourcesMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

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

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

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

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

getContributingSOPInstancesReferenceSequence

public ContributingSOPInstancesReferenceSequence getContributingSOPInstancesReferenceSequence()

Retrieves pre-initialized object of Contributing SOP InstancesReference 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:

ContributingSOPInstancesReferenceSequence - instance of ContributingSOPInstancesReferenceSequence.

setManufacturer

public void setManufacturer(java.lang.String strManufacturer)

Sets the Manufacturer of the equipment used for beam delivery..

Parameters:

strManufacturer - String value of Manufacturer .

getManufacturer

public java.lang.String getManufacturer()

Retrieves Manufacturer of the equipment used for beam delivery.

Returns:

String - value of Manufacturer.

setManufacturersModelName

public void setManufacturersModelName(java.lang.String strManufacturersModelName)

getManufacturersModelName

public java.lang.String getManufacturersModelName()

Retrieves Manufacturer's model name of the equipment used for beam delivery.

Returns:

String - value of Manufacturers Model Name.

setDeviceSerialNumber

public void setDeviceSerialNumber(java.lang.String strDeviceSerialNumber)

Sets Manufacturer's serial number of the equipment used for beam delivery.

Parameters:

strDeviceSerialNumber - String value of Device Serial Number.

getDeviceSerialNumber

public java.lang.String getDeviceSerialNumber()

Retrieves Manufacturer's serial number of the equipment used for beam delivery.

Returns:

String - value of Device Serial Number.

setSoftwareVersions

public void setSoftwareVersions(java.lang.String[] strSoftwareVersions)

Sets Manufacturer�s designation of the software version of the equipment that contributed to the composite instance.

Parameters:

strSoftwareVersions - String Array of Software Versions.

getSoftwareVersions

public java.lang.String[] getSoftwareVersions()

Retrieves Manufacturer�s designation of the software version of the equipment that contributed to the composite instance.

Returns:

String[] - String Array of Software Versions.

setAcquisitionDatetime

public void setAcquisitionDatetime(java.lang.String strAcquisitionDatetime)

Sets the date and time the acquisition of data that resulted in this image started.

Parameters:

strAcquisitionDatetime - String value of Acquisition Date and Time.

getAcquisitionDatetime

public java.lang.String getAcquisitionDatetime()

Retrieves the Date and Time of Acquisition

Returns:

String - returns the Date and Time of Acquisition

setStationName

public void setStationName(java.lang.String strStationName)

Sets User defined name identifying the machine that contributed to the composite instance.

Parameters:

strStationName - String value of Station Name.

getStationName

public java.lang.String getStationName()

Retrieves User defined name identifying the machine that contributed to the composite instance.

Returns:

String - value of Station Name.

setOperatorsName

public void setOperatorsName(java.lang.String[] arrStrOperatorsName)

Sets the Name of operator. Name(s) of the operator(s) of the contributing equipment.

Parameters:

arrStrOperatorsName - String array of Operators Name .

getOperatorsName

public java.lang.String[] getOperatorsName()

Retrieves Name of operator. Name(s) of the operator(s) of the contributing equipment.

Returns:

String - array of Operators Name.

getOperatorIdentificationSequence

public OperatorIdentificationSequence getOperatorIdentificationSequence()

Retrieves pre-initialized object of Operator Identification 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:

OperatorIdentificationSequence - instance of OperatorIdentificationSequence.

setProtocolName

public void setProtocolName(java.lang.String StrProtocolName)

Sets attribute identifies User-defined description of the conditions under which the Series was performed.

Parameters:

StrProtocolName - String User-defined description

getProtocolName

public java.lang.String getProtocolName()

Return User-defined description of the conditions under which the Series was performed.

Returns:

String - User-defined description.

getPerformedProtocolCodeSequence

public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()

Retrieves pre-initialized object of Performed Protocol 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:

PerformedProtocolCodeSequence - instance of PerformedProtocolCodeSequence.

setAcquisitionProtocolName

public void setAcquisitionProtocolName(java.lang.String strAcquisitionProtocolName)

Sets Acquisition Protocol Name.

Parameters:

strAcquisitionProtocolName - String value of AcquisitionProtocolName.

getAcquisitionProtocolName

public java.lang.String getAcquisitionProtocolName()

Return user-defined label identifier for AcquisitionProtocolName.

Returns:

String - value of AcquisitionProtocolName.