GrayscaleSoftcopyPresentationStateIOD

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD
- - cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD
  - - cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NonImageIOD
    - - cdac.medinfo.sdk.dcm30_04.dicommodel.grayscalesoftcopy.GrayscaleSoftcopyPresentationStateIOD

```
public class GrayscaleSoftcopyPresentationStateIOD
extends NonImageIOD
```
The Grayscale Softcopy Presentation State Information Object Definition (IOD) specifies information that may be used to present (display) images that are referenced from within the IOD.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD
The Constant GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD` The Constant GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD.

Constructor Summary

Constructors
Constructor and Description
`GrayscaleSoftcopyPresentationStateIOD()` Instantiates a new grayscale softcopy presentation state iod.
`GrayscaleSoftcopyPresentationStateIOD(IDataSet objIDataSet_)` This constructor accepts the DataSet from the user in its superclass IOD.
`GrayscaleSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_)` This constructor initializes the DictionaryReader in its superclass IOD.
`GrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_)` This constructor initializes the TransferSyntax in its superclass IOD.
`GrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_)` This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
`GrayscaleSoftcopyPresentationStateIOD(java.lang.String strFileName)` Creates GrayscaleSoftcopyPresentationStateIOD IOD from a DICOM file containing GrayscaleSoftcopyPresentationStateIOD DICOM data.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dumpDICOMInfo(IDicomStream objIDicomStream)` Dumps the Name of IOD,Module and corresponding Attributs of Module.
`BitmapDisplayShutterModule`	`getBitmapDisplayShutterModule()` Retrieves pre-initialized instance of Bitmap Display Shutter Module.
`ClinicalTrialSeriesModule`	`getClinicalTrialSeriesModule()` Retrieves pre-initialized instance of ClinicalTrialSeriesModule.
`DisplayedAreaModule`	`getDisplayedAreaModule()` Retrieves pre-initialized instance of DisplayedAreaModule.
`DisplayShutterModule`	`getDisplayShutter()` Retrieves pre-initialized instance of DisplayShutterModule.
`DisplayShutterModule`	`getDisplayShutterModule()` Retrieves pre-initialized instance of DisplayShutterModule.
`GeneralEquipmentModule`	`getGeneralEquipmentModule()` Retrieves pre-initialized instance of GeneralEquipmentModule.
`GeneralSeriesModule`	`getGeneralSeriesModule()` Retrieves pre-initialized instance of GeneralSeriesModule.
`GeneralStudyModule`	`getGeneralStudyModule()` Retrieves pre-initialized instance of GeneralStudyModule.
`GraphicAnnotationModule`	`getGraphicAnnotationModule()` Retrieves pre-initialized instance of GraphicAnnotationModule.
`GraphicGroupModule`	`getGraphicGroupModule()` Retrieves pre-initialized instance of Graphic Group Module.
`GraphicLayerModule`	`getGraphicLayerModule()` Retrieves pre-initialized instance of GraphicLayerModule.
`MaskModule`	`getMaskModule()` Retrieves pre-initialized instance of MaskModule.
`ModalityLUTModule`	`getModalityLUTModule()` Retrieves pre-initialized instance of ModalityLUTModule.
`OverlayCurveActivationModule`	`getOverlayCurveActivationModule()` Retrieves pre-initialized instance of OverlayCurveActivationModule.
`OverlayPlaneModule`	`getOverlayPlaneModule()` Retrieves pre-initialized instance of OverlayPlaneModule.
`PatientModule`	`getPatientModule()` Retrieves pre-initialized instance of PatientModule.
`PatientStudyModule`	`getPatientStudyModule()` Retrieves pre-initialized instance of PatientStudyModule.
`PresentationSeriesModule`	`getPresentationSeriesModule()` Retrieves pre-initialized instance of PresentationSeriesModule.
`PresentationStateMaskModule`	`getPresentationStateMaskModule()` Retrieves pre-initialized instance of Presentation State Mask Module.
`PresentationStateModule`	`getPresentationStateModule()` Retrieves pre-initialized instance of PresentationStateModule.
`PresentationStateRelationshipModule`	`getPresentationStateRelationshipModule()` Retrieves pre-initialized instance of Presentation State RelationshipModule.
`PresentationStateShutterModule`	`getPresentationStateShutterModule()` Retrieves pre-initialized instance of Presentation State Shutter Module.
`SoftcopyPresentationLUTModule`	`getSoftcopyPresentationLUTModule()` Retrieves pre-initialized instance of SoftcopyPresentationLUTModule.
`SoftcopyVOILUTModule`	`getSoftcopyVOILUTModule()` Retrieves pre-initialized instance of SoftcopyVOILUTModule.
`SOPCommonModule`	`getSOPCommonModule()` Retrieves pre-initialized instance of SOPCommonModule.
`SpatialTransformationModule`	`getSpatialTransformationModule()` Retrieves pre-initialized instance of SpatialTransformationModule.
`boolean`	`isModulePresent(java.lang.String strModuleName)` Checks whether the Module is present in the IOD or not.
`boolean`	`validate()` This method validates Non-Image IOD Grayscale Softcopy Presentation State IOD according to the Module Table given in The DICOM Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD
getClinicalTrialStudyModule, getClinicalTrialSubjectModule

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD
addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD
```
public static final java.lang.String GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD
```
    The Constant GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD()
```
    Instantiates a new grayscale softcopy presentation state iod.
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_)
```
    This constructor initializes the TransferSyntax in its superclass IOD.
    
    Parameters:
    objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_)
```
    This constructor initializes the DictionaryReader in its superclass IOD.
    
    Parameters:
    objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD(IDataSet objIDataSet_)
```
    This constructor accepts the DataSet from the user in its superclass IOD.
    
    Parameters:
    objIDataSet_ - - specifies the data set to be set in the IOD.
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_,
                                     IDictionaryReader objIDictionaryReader_)
```
    This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
    
    Parameters:
    objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.
    objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .
  - GrayscaleSoftcopyPresentationStateIOD
```
public GrayscaleSoftcopyPresentationStateIOD(java.lang.String strFileName)
                                      throws java.io.IOException,
                                             InvalidIODException
```
    Creates GrayscaleSoftcopyPresentationStateIOD IOD from a DICOM file containing GrayscaleSoftcopyPresentationStateIOD DICOM data.
    
    Parameters:
    strFileName - DICOM File with absolute path.
    
    Throws:
    
    java.io.IOException - Exception caused due to wrong I/O operations.
    
    ParseException - signals if some parse exceptions are occurred.
    
    InvalidIODException - signals if some IOD exceptions are occurred.
- Method Detail
  - getBitmapDisplayShutterModule
```
public BitmapDisplayShutterModule getBitmapDisplayShutterModule()
```
    Retrieves pre-initialized instance of Bitmap Display Shutter Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    BitmapDisplayShutterModule - instance of BitmapDisplayShutterModule.
  - getClinicalTrialSeriesModule
```
public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()
```
    Retrieves pre-initialized instance of ClinicalTrialSeriesModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.
  - getDisplayedAreaModule
```
public DisplayedAreaModule getDisplayedAreaModule()
```
    Retrieves pre-initialized instance of DisplayedAreaModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    DisplayedAreaModule - instance of DisplayedAreaModule.
  - getDisplayShutterModule
```
public DisplayShutterModule getDisplayShutterModule()
```
    Retrieves pre-initialized instance of DisplayShutterModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    DisplayShutterModule - instance of DisplayShutterModule.
  - getGeneralEquipmentModule
```
public GeneralEquipmentModule getGeneralEquipmentModule()
```
    Retrieves pre-initialized instance of GeneralEquipmentModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GeneralEquipmentModule - instance of GeneralEquipmentModule.
  - getGeneralSeriesModule
```
public GeneralSeriesModule getGeneralSeriesModule()
```
    Retrieves pre-initialized instance of GeneralSeriesModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GeneralSeriesModule - instance of GeneralSeriesModule.
  - getGeneralStudyModule
```
public GeneralStudyModule getGeneralStudyModule()
```
    Retrieves pre-initialized instance of GeneralStudyModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GeneralStudyModule - instance of GeneralStudyModule.
  - getGraphicAnnotationModule
```
public GraphicAnnotationModule getGraphicAnnotationModule()
```
    Retrieves pre-initialized instance of GraphicAnnotationModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GraphicAnnotationModule - instance of GraphicAnnotationModule.
  - getGraphicLayerModule
```
public GraphicLayerModule getGraphicLayerModule()
```
    Retrieves pre-initialized instance of GraphicLayerModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GraphicLayerModule - instance of GraphicLayerModule.
  - getMaskModule
```
public MaskModule getMaskModule()
```
    Retrieves pre-initialized instance of MaskModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    MaskModule - instance of MaskModule.
  - getModalityLUTModule
```
public ModalityLUTModule getModalityLUTModule()
```
    Retrieves pre-initialized instance of ModalityLUTModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    ModalityLUTModule - instance of ModalityLUTModule.
  - getOverlayCurveActivationModule
```
public OverlayCurveActivationModule getOverlayCurveActivationModule()
```
    Retrieves pre-initialized instance of OverlayCurveActivationModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    OverlayCurveActivationModule - instance of OverlayCurveActivationModule.
  - getOverlayPlaneModule
```
public OverlayPlaneModule getOverlayPlaneModule()
```
    Retrieves pre-initialized instance of OverlayPlaneModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    OverlayPlaneModule - instance of OverlayPlaneModule.
  - getPatientModule
```
public PatientModule getPatientModule()
```
    Retrieves pre-initialized instance of PatientModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PatientModule - instance of PatientModule.
  - getPatientStudyModule
```
public PatientStudyModule getPatientStudyModule()
```
    Retrieves pre-initialized instance of PatientStudyModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PatientStudyModule - instance of PatientStudyModule.
  - getPresentationSeriesModule
```
public PresentationSeriesModule getPresentationSeriesModule()
```
    Retrieves pre-initialized instance of PresentationSeriesModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PresentationSeriesModule - instance of PresentationSeriesModule.
  - getPresentationStateModule
```
public PresentationStateModule getPresentationStateModule()
```
    Retrieves pre-initialized instance of PresentationStateModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PresentationStateModule - instance of PresentationStateModule.
  - getSoftcopyPresentationLUTModule
```
public SoftcopyPresentationLUTModule getSoftcopyPresentationLUTModule()
```
    Retrieves pre-initialized instance of SoftcopyPresentationLUTModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    SoftcopyPresentationLUTModule - instance of SoftcopyPresentationLUTModule.
  - getSoftcopyVOILUTModule
```
public SoftcopyVOILUTModule getSoftcopyVOILUTModule()
```
    Retrieves pre-initialized instance of SoftcopyVOILUTModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    SoftcopyVOILUTModule - instance of SoftcopyVOILUTModule.
  - getSOPCommonModule
```
public SOPCommonModule getSOPCommonModule()
```
    Retrieves pre-initialized instance of SOPCommonModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    SOPCommonModule - instance of SOPCommonModule.
  - getSpatialTransformationModule
```
public SpatialTransformationModule getSpatialTransformationModule()
```
    Retrieves pre-initialized instance of SpatialTransformationModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    SpatialTransformationModule - instance of SpatialTransformationModule.
  - getDisplayShutter
```
public DisplayShutterModule getDisplayShutter()
```
    Retrieves pre-initialized instance of DisplayShutterModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    DisplayShutterModule - instance of DisplayShutterModule.
  - getPresentationStateRelationshipModule
```
public PresentationStateRelationshipModule getPresentationStateRelationshipModule()
```
    Retrieves pre-initialized instance of Presentation State RelationshipModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PresentationStateRelationshipModule - instance of PresentationStateRelationshipModule.
  - getPresentationStateShutterModule
```
public PresentationStateShutterModule getPresentationStateShutterModule()
```
    Retrieves pre-initialized instance of Presentation State Shutter Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PresentationStateShutterModule - instance of State Shutter.
  - getPresentationStateMaskModule
```
public PresentationStateMaskModule getPresentationStateMaskModule()
```
    Retrieves pre-initialized instance of Presentation State Mask Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    PresentationStateMaskModule - instance of PresentationStateMaskModule.
  - getGraphicGroupModule
```
public GraphicGroupModule getGraphicGroupModule()
```
    Retrieves pre-initialized instance of Graphic Group Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.
    
    Returns:
    GraphicGroupModule - instance of GraphicGroupModule.
  - validate
```
public boolean validate()
                 throws InvalidIODException
```
    This method validates Non-Image IOD Grayscale Softcopy Presentation State IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.
    
    Overrides:
    
    validate in class NonImageIOD
    
    Returns:
    boolean - status of validation as success or failure
    
    Throws:
    
    InvalidIODException - - throws when the IOD is invalid.
  - dumpDICOMInfo
```
public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException
```
    Dumps the Name of IOD,Module and corresponding Attributs of Module.
    
    Overrides:
    
    dumpDICOMInfo in class CompositeIOD
    
    Parameters:
    objIDicomStream - - the Stream on which the Data is to be written.
    
    Throws:
    
    java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.
  - isModulePresent
```
public boolean isModulePresent(java.lang.String strModuleName)
```
    Checks whether the Module is present in the IOD or not.
    
    Overrides:
    
    isModulePresent in class NonImageIOD
    
    Parameters:
    strModuleName - String value of module name
    
    Returns:
    boolean - true if the module is present in the IOD, else false is returned.

Class GrayscaleSoftcopyPresentationStateIOD

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

GRAYSCALE_SOFTCOPY_PRESENTATION_STATE_IOD

Constructor Detail

GrayscaleSoftcopyPresentationStateIOD

GrayscaleSoftcopyPresentationStateIOD

GrayscaleSoftcopyPresentationStateIOD

GrayscaleSoftcopyPresentationStateIOD

GrayscaleSoftcopyPresentationStateIOD

GrayscaleSoftcopyPresentationStateIOD

Method Detail

getBitmapDisplayShutterModule

getClinicalTrialSeriesModule

getDisplayedAreaModule

getDisplayShutterModule

getGeneralEquipmentModule

getGeneralSeriesModule

getGeneralStudyModule

getGraphicAnnotationModule

getGraphicLayerModule

getMaskModule

getModalityLUTModule

getOverlayCurveActivationModule

getOverlayPlaneModule

getPatientModule

getPatientStudyModule

getPresentationSeriesModule

getPresentationStateModule

getSoftcopyPresentationLUTModule

getSoftcopyVOILUTModule

getSOPCommonModule

getSpatialTransformationModule

getDisplayShutter

getPresentationStateRelationshipModule

getPresentationStateShutterModule

getPresentationStateMaskModule

getGraphicGroupModule

validate

dumpDICOMInfo

isModulePresent