cdac.medinfo.sdk.dcm30_04.baselibs

Class IdentifiedPersonorDeviceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.IdentifiedPersonorDeviceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class IdentifiedPersonorDeviceMacro
extends Macro

This class describes a Macro which defines the Attributes that identify a person or a device participating as an observer for the context of an SR Instance.This macro contains content equivalent to TID 1002.

Author:

saloni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentifiedPersonorDeviceMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
IdentifiedPersonorDeviceMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
IdentifiedPersonorDeviceMacro(IItem objItem) This constructor constructs a Macro with the specified Item
IdentifiedPersonorDeviceMacro(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	getDeviceUID() Retrieves a Device UID.
InstitutionCodeSequence	getInstitutionCodeSequence() Retrieves pre-initialized object of Institution 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	getInstitutionName() Retrieves Institution Name.
java.lang.String	getManufacturer() Return Manufacturer.
java.lang.String	getManufacturersModelName() Retrieves Manufacturer's model name.
java.lang.String	getObserverType() Return type of Observer.
PersonIdentificationCodeSequence	getPersonIdentificationCodeSequence() Retrieves pre-initialized object of Person Identification 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	getPersonName() Retrieves Person Name.
java.lang.String	getStationName() Retrieves Station Name.
void	setDeviceUID(java.lang.String strDeviceUID) Sets a Device UID.
void	setInstitutionName(java.lang.String strInstitutionName) Sets Institution Name.
void	setManufacturer(java.lang.String strManufacturer) Sets Manufacturer.
void	setManufacturersModelName(java.lang.String strManufacturersModelName) Sets Manufacturer's model name.
void	setObserverType(EnumObserverType enumObserverType) Sets type of Observer.
void	setPersonName(java.lang.String strPersonName) Sets Person Name.
void	setStationName(java.lang.String strStationName) Sets the Station Name.
boolean	validate() Validates all the attributes in IdentifiedPersonorDeviceMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in IdentifiedPersonorDeviceMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in IdentifiedPersonorDeviceMacro 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

IdentifiedPersonorDeviceMacro

public IdentifiedPersonorDeviceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

IdentifiedPersonorDeviceMacro

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

IdentifiedPersonorDeviceMacro

public IdentifiedPersonorDeviceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

IdentifiedPersonorDeviceMacro

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

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

setObserverType

public void setObserverType(EnumObserverType enumObserverType)

Sets type of Observer. Defined Terms: 1) PSN. 2) DEV.

Parameters:

enumObserverType - enum value of Observer Type.

getObserverType

public java.lang.String getObserverType()

Return type of Observer.

Returns:

String - value of Observer Type.

setPersonName

public void setPersonName(java.lang.String strPersonName)

Sets Person Name. Name of the person observer for this document Instance.

Parameters:

strPersonName - String Person Name.

getPersonName

public java.lang.String getPersonName()

Retrieves Person Name. Name of the person observer for this document Instance.

Returns:

String - Name of the Person.

getPersonIdentificationCodeSequence

public PersonIdentificationCodeSequence getPersonIdentificationCodeSequence()

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

PersonIdentificationCodeSequence - instance of PersonIdentificationCodeSequence.

setStationName

public void setStationName(java.lang.String strStationName)

Sets the Station Name. Name of the device observer for this document instance.

Parameters:

strStationName - - value of Station Name

getStationName

public java.lang.String getStationName()

Retrieves Station Name. Name of the device observer for this document instance.

Returns:

String - value of Station Name.

setDeviceUID

public void setDeviceUID(java.lang.String strDeviceUID)

Sets a Device UID. Unique identifier of device observer.

Parameters:

strDeviceUID - String value of Device UID.

getDeviceUID

public java.lang.String getDeviceUID()

Retrieves a Device UID. Unique identifier of device observer.

Returns:

String - value of Device UID.

setManufacturer

public void setManufacturer(java.lang.String strManufacturer)

Sets Manufacturer.

Parameters:

strManufacturer - String value of Manufacturer.

getManufacturer

public java.lang.String getManufacturer()

Return Manufacturer.

Returns:

String - value of Manufacturer.

setManufacturersModelName

public void setManufacturersModelName(java.lang.String strManufacturersModelName)

Sets Manufacturer's model name. Model Name of the device observer.

Parameters:

strManufacturersModelName - String value of Manufacturers Model Name .

getManufacturersModelName

public java.lang.String getManufacturersModelName()

Retrieves Manufacturer's model name. Model Name of the device observer.

Returns:

String - value of Manufacturers Model Name.

setInstitutionName

public void setInstitutionName(java.lang.String strInstitutionName)

Sets Institution Name.

Parameters:

strInstitutionName - String value of Institution Name .

getInstitutionName

public java.lang.String getInstitutionName()

Retrieves Institution Name.

Returns:

String - value of Institution Name.

getInstitutionCodeSequence

public InstitutionCodeSequence getInstitutionCodeSequence()

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

InstitutionCodeSequence - instance of InstitutionCodeSequence.