cdac.medinfo.sdk.dcm30_04.baselibs

Class AlgorithmIdentificationMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.AlgorithmIdentificationMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class AlgorithmIdentificationMacro
extends Macro

This class describes the Macro which contains attributes for encoding the algorithm which are used to create or derive a SOP Instance contents. An algorithm is described by the Algorithm Family, a specific Algorithm Name, and an Algorithm Version.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AlgorithmFamilyCodeSequence	getAlgorithmFamilyCodeSequence() Retrieves pre-initialized object of Algorithm Family 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	getAlgorithmName() Return Algorithm Name.
AlgorithmNameCodeSequence	getAlgorithmNameCodeSequence() Retrieves pre-initialized object of Algorithm Name 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	getAlgorithmParameters() Retrieves Algorithm Parameters.
java.lang.String	getAlgorithmSource() Return Algorithm Source.
java.lang.String	getAlgorithmVersion() Return Algorithm Version.
void	setAlgorithmName(java.lang.String strAlgorithmName) Sets Algorithm Name.
void	setAlgorithmParameters(java.lang.String strAlgorithmParameters) Sets Algorithm Parameters.
void	setAlgorithmSource(java.lang.String strAlgorithmSource) Sets Algorithm Source.
void	setAlgorithmVersion(java.lang.String strAlgorithmVersion) Sets Algorithm Version.
boolean	validate() Validates all the attributes in AlgorithmIdentificationMacro.
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in AlgorithmIdentificationMacro that are present in the DataSet.
static boolean	validate(IItem objIItem) Validates all the attributes in AlgorithmIdentificationMacro 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

AlgorithmIdentificationMacro

public AlgorithmIdentificationMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

AlgorithmIdentificationMacro

public AlgorithmIdentificationMacro(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

AlgorithmIdentificationMacro

public AlgorithmIdentificationMacro(IItem objItem)

This constructor constructs a Macro with the specified Item.

Parameters:

objItem - specifies instance of Item class

AlgorithmIdentificationMacro

public AlgorithmIdentificationMacro(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 AlgorithmIdentificationMacro.

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 AlgorithmIdentificationMacro 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 AlgorithmIdentificationMacro 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.

getAlgorithmFamilyCodeSequence

public AlgorithmFamilyCodeSequence getAlgorithmFamilyCodeSequence()

Retrieves pre-initialized object of Algorithm Family 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:

AlgorithmFamilyCodeSequence - instance of AlgorithmFamilyCodeSequence.

getAlgorithmNameCodeSequence

public AlgorithmNameCodeSequence getAlgorithmNameCodeSequence()

Retrieves pre-initialized object of Algorithm Name 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:

AlgorithmNameCodeSequence - instance of AlgorithmNameCodeSequence.

setAlgorithmName

public void setAlgorithmName(java.lang.String strAlgorithmName)

Sets Algorithm Name. The name assigned by a manufacturer to a specific software algorithm.

Parameters:

strAlgorithmName- - String value of Algorithm Name.

getAlgorithmName

public java.lang.String getAlgorithmName()

Return Algorithm Name. The name assigned by a manufacturer to a specific software algorithm.

Returns:

String - value of Algorithm Name.

setAlgorithmVersion

public void setAlgorithmVersion(java.lang.String strAlgorithmVersion)

Sets Algorithm Version. The software version identifier assigned by a manufacturer to a specific software algorithm.

Parameters:

strAlgorithmVersion - -String value of Algorithm Version.

getAlgorithmVersion

public java.lang.String getAlgorithmVersion()

Return Algorithm Version. The software version identifier assigned by a manufacturer to a specific software algorithm.

Returns:

String - value of Algorithm Version.

setAlgorithmParameters

public void setAlgorithmParameters(java.lang.String strAlgorithmParameters)

Sets Algorithm Parameters.

Parameters:

strAlgorithmParameters- - String value of Algorithm Parameters.

getAlgorithmParameters

public java.lang.String getAlgorithmParameters()

Retrieves Algorithm Parameters.

Returns:

String - value of Algorithm Parameters.

setAlgorithmSource

public void setAlgorithmSource(java.lang.String strAlgorithmSource)

Sets Algorithm Source.

Parameters:

strAlgorithmSource - -String value of Algorithm Source.

getAlgorithmSource

public java.lang.String getAlgorithmSource()

Return Algorithm Source.

Returns:

String - value of Algorithm Source.