cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageSOPInstanceReferenceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ImageSOPInstanceReferenceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ImageSOPInstanceReferenceMacro
extends Macro

This Macro contains attributes of Image SOP Instance Reference Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getReferencedFrameNumber() Retrieves the frame numbers within the Referenced SOP Instance to which the reference applies
short[]	getReferencedSegmentNumber() Retrieves Referenced Segment Number.
SOPInstanceReferenceMacro	getSOPInstanceReferenceMacro() This method returns the SOP Instance Reference Macro with proper initialization.
void	setReferencedFrameNumber(java.lang.String[] arrstrReferencedFrameNumber) Sets the frame numbers within the Referenced SOP Instance to which the reference applies
void	setReferencedSegmentNumber(short[] arrShReferencedSegmentNumber) Sets Referenced Segment Number Identifies the Segment Number to which the reference applies.
boolean	validate() Validates all the attributes in Image SOP Instance Reference Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Image SOP Instance Reference Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Image SOP Instance Reference Macro 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

ImageSOPInstanceReferenceMacro

public ImageSOPInstanceReferenceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

ImageSOPInstanceReferenceMacro

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

ImageSOPInstanceReferenceMacro

public ImageSOPInstanceReferenceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ImageSOPInstanceReferenceMacro

public ImageSOPInstanceReferenceMacro(IItem objItem,
                              IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and Dictionary Reader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

getSOPInstanceReferenceMacro

public SOPInstanceReferenceMacro getSOPInstanceReferenceMacro()

This method returns the SOP Instance Reference Macro with proper initialization.

Returns:

- instance of SOPInstanceReferenceMacro

setReferencedFrameNumber

public void setReferencedFrameNumber(java.lang.String[] arrstrReferencedFrameNumber)

Sets the frame numbers within the Referenced SOP Instance to which the reference applies

Parameters:

arrstrReferencedFrameNumber - String array of frame numbers

getReferencedFrameNumber

public java.lang.String[] getReferencedFrameNumber()

Retrieves the frame numbers within the Referenced SOP Instance to which the reference applies

Returns:

String[] - String array of frame numbers

setReferencedSegmentNumber

public void setReferencedSegmentNumber(short[] arrShReferencedSegmentNumber)

Sets Referenced Segment Number Identifies the Segment Number to which the reference applies.

Parameters:

arrShReferencedSegmentNumber -

getReferencedSegmentNumber

public short[] getReferencedSegmentNumber()

Retrieves Referenced Segment Number. Identifies the Segment Number to which the reference applies.

Returns:

short Array - Referenced Segment Number.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Image SOP Instance Reference Macro

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 Image SOP Instance Reference Macro 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 Image SOP Instance Reference Macro 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.