cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SynchronizationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SynchronizationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SynchronizationModule
extends Module

\* This module specifies the Attributes necessary to uniquely identify a frame of reference that establishes the temporal relationship of SOP Instances.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
SynchronizationModule(IDataSet objIDataSet) Instantiates a new synchronization module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionTimeSynchronized() Returns Acquisition Datetime (0008,002A) synchronized with external time reference.
java.lang.String	getNTPSourceAddress() Returns IP Address of NTP time source.
short[]	getSynchronizationChannel() Returns Identifier of waveform channel that records the synchronization channel or trigger.
java.lang.String	getSynchronizationFrameOfReferenceUID() Returns UID of common synchronization environment.
java.lang.String	getSynchronizationTrigger() Returns Data acquisition synchronization with external equipment.
java.lang.String	getTimeDistributionProtocol() Returns Method of time distribution used to synchronize this equipment.
java.lang.String	getTimeSource() Returns ID of equipment or system providing time reference.
java.lang.String	getTriggerSourceOrType() Returns Specifies equipment ID of trigger source and/or type of trigger.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAcquisitionTimeSynchronized(EnumAcquisitionTimeSynchronized enumAcquisitionTimeSynchronized) Sets Acquisition Datetime (0008,002A) synchronized with external time reference.
void	setNTPSourceAddress(java.lang.String strNTPSourceAddress) Sets IP Address of NTP time source.
void	setSynchronizationChannel(short[] arrShSynchronizationChannel) Sets Identifier of waveform channel that records the synchronization channel or trigger.
void	setSynchronizationFrameOfReferenceUID(java.lang.String strSynchronizationFrameOfReferenceUID) Sets UID of common synchronization environment.A set of equipment may share a common acquisition synchronization environment, which is identified by a Synchronization Frame of Reference UID.
void	setSynchronizationTrigger(EnumSynchronizationTrigger enumSynchronizationTrigger) Sets Data acquisition synchronization with external equipment.
void	setTimeDistributionProtocol(EnumTimeDistributionProtocol enumTimeDistributionProtocol) Sets Method of time distribution used to synchronize this equipment.
void	setTimeSource(java.lang.String strTimeSource) Sets ID of equipment or system providing time reference.
void	setTriggerSourceOrType(java.lang.String strTriggerSourceOrType) Sets value that Specifies equipment ID of trigger source and/or type of trigger.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

SynchronizationModule

public SynchronizationModule(IDataSet objIDataSet)

Instantiates a new synchronization module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setSynchronizationFrameOfReferenceUID

public void setSynchronizationFrameOfReferenceUID(java.lang.String strSynchronizationFrameOfReferenceUID)

Sets UID of common synchronization environment.A set of equipment may share a common acquisition synchronization environment, which is identified by a Synchronization Frame of Reference UID.

Parameters:

strSynchronizationFrameOfReferenceUID - - String valuer of Synchronization Frame of Reference UID

setSynchronizationTrigger

public void setSynchronizationTrigger(EnumSynchronizationTrigger enumSynchronizationTrigger)

Sets Data acquisition synchronization with external equipment. Enumerated Values: SOURCE - this equipment provides synchronization channel or trigger to other equipment ,EXTERNAL - this equipment receives synchronization channel or trigger from other equipment ,PASSTHRU - this equipment receives synchronization channel or trigger and forwards it ,NO TRIGGER - data acquisition not synchronized by common channel or trigger

Parameters:

enumSynchronizationTrigger - - Enum value of Synchronization Trigger.

setTriggerSourceOrType

public void setTriggerSourceOrType(java.lang.String strTriggerSourceOrType)

Sets value that Specifies equipment ID of trigger source and/or type of trigger.

Parameters:

strTriggerSourceOrType - - String value of Trigger Source or Type

setSynchronizationChannel

public void setSynchronizationChannel(short[] arrShSynchronizationChannel)

Sets Identifier of waveform channel that records the synchronization channel or trigger. Required if synchronization channel or trigger is encoded in a waveform in this SOP Instance

Parameters:

arrShSynchronizationChannel - - short array of Synchronization Channel

setAcquisitionTimeSynchronized

public void setAcquisitionTimeSynchronized(EnumAcquisitionTimeSynchronized enumAcquisitionTimeSynchronized)

Sets Acquisition Datetime (0008,002A) synchronized with external time reference. Enumerated Values: Y, N.

Parameters:

enumAcquisitionTimeSynchronized - - enum value of Acquisition Time Synchronized

setTimeSource

public void setTimeSource(java.lang.String strTimeSource)

Sets ID of equipment or system providing time reference.

Parameters:

strTimeSource - - String value of Time Source

setTimeDistributionProtocol

public void setTimeDistributionProtocol(EnumTimeDistributionProtocol enumTimeDistributionProtocol)

Sets Method of time distribution used to synchronize this equipment. Defined Terms: NTP - Network Time Protocol,IRIG - InterRange Instrumentation Group, GPS - Global Positioning System, SNTP Simple Network Time Protocol

Parameters:

enumTimeDistributionProtocol - the enum time distribution protocol

setNTPSourceAddress

public void setNTPSourceAddress(java.lang.String strNTPSourceAddress)

Sets IP Address of NTP time source. IPv4 addresses shall be in dotted decimal (e.g. 192.168.1.1). The IPv6 addresses shall be in colon separated hexadecimal (e.g. 12:34:56:78:9a:bc:de:f0).

Parameters:

strNTPSourceAddress - - String value of NTP Source Address

getSynchronizationFrameOfReferenceUID

public java.lang.String getSynchronizationFrameOfReferenceUID()

Returns UID of common synchronization environment.

Returns:

String - String value of Synchronization Frame Of Reference UID.

getSynchronizationTrigger

public java.lang.String getSynchronizationTrigger()

Returns Data acquisition synchronization with external equipment.

Returns:

String - String value of Synchronization Trigger.

getTriggerSourceOrType

public java.lang.String getTriggerSourceOrType()

Returns Specifies equipment ID of trigger source and/or type of trigger.

Returns:

String - String value of equipment ID of trigger source and/or type of trigger

getSynchronizationChannel

public short[] getSynchronizationChannel()

Returns Identifier of waveform channel that records the synchronization channel or trigger.

Returns:

short[] - short array of Synchronization Channel

getAcquisitionTimeSynchronized

public java.lang.String getAcquisitionTimeSynchronized()

Returns Acquisition Datetime (0008,002A) synchronized with external time reference.

Returns:

String - String value of Acquisition Time Synchronized

getTimeSource

public java.lang.String getTimeSource()

Returns ID of equipment or system providing time reference.

Returns:

String - String value of Time Source.

getTimeDistributionProtocol

public java.lang.String getTimeDistributionProtocol()

Returns Method of time distribution used to synchronize this equipment.

Returns:

String - String value of Time Distribution Protocol.

getNTPSourceAddress

public java.lang.String getNTPSourceAddress()

Returns IP Address of NTP time source.

Returns:

String - String value of NTP Source Address

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags