cdac.medinfo.sdk.dcm30_04.baselibs

Class TemporalCoordinatesMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.TemporalCoordinatesMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class TemporalCoordinatesMacro
extends Macro

Temporal Coordinates Macro specifies the Attributes that convey TCOORD Content Items. A TCOORD Content Item shall be the Source Content Item of one or more SELECTED FROM relationships with one or more SCOORD Content Items, one or more IMAGE Content Items, or one or more WAVEFORM Content Items.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TemporalCoordinatesMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
TemporalCoordinatesMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
TemporalCoordinatesMacro(IItem objItem) This constructor constructs a Macro with the specified Item
TemporalCoordinatesMacro(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[]	getReferencedDatetime() Return temporal points for reference by absolute time.
int[]	getReferencedSamplePositions() Return Referenced Sample Positions
java.lang.String[]	getReferencedTimeOffsets() Return temporal points for reference by number of seconds after start of data.
java.lang.String	getTemporalRangeType() Return the type of temporal extent of the region of interest
void	setReferencedDatetime(java.lang.String[] arrStrReferencedDatetime) Sets temporal points for reference by absolute time.
void	setReferencedSamplePositions(int[] lArrReferencedSamplePositions) Sets List of samples within a multiplex group specifying temporal points of the referenced data.
void	setReferencedTimeOffsets(java.lang.String[] arrStrReferencedTimeOffsets) Sets temporal points for reference by number of seconds after start of data.
void	setTemporalRangeType(EnumTemporalRangeType enumTemporalRangeType) This Attribute defines the type of temporal extent of the region of interest
boolean	validate() Validates all the attributes in Temporal Coordinates Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Temporal Coordinates Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Temporal Coordinates 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

TemporalCoordinatesMacro

public TemporalCoordinatesMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

TemporalCoordinatesMacro

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

TemporalCoordinatesMacro

public TemporalCoordinatesMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

TemporalCoordinatesMacro

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

setTemporalRangeType

public void setTemporalRangeType(EnumTemporalRangeType enumTemporalRangeType)

This Attribute defines the type of temporal extent of the region of interest

Parameters:

enumTemporalRangeType - String value of Temporal Range Type

getTemporalRangeType

public java.lang.String getTemporalRangeType()

Return the type of temporal extent of the region of interest

Returns:

String - value of Temporal Range Type

setReferencedSamplePositions

public void setReferencedSamplePositions(int[] lArrReferencedSamplePositions)

Sets List of samples within a multiplex group specifying temporal points of the referenced data. Position of first sample is 1.

Parameters:

lArrReferencedSamplePositions - int array of Referenced Sample Positions

getReferencedSamplePositions

public int[] getReferencedSamplePositions()

Return Referenced Sample Positions

Returns:

long[] - long array of Referenced Sample Positions

setReferencedTimeOffsets

public void setReferencedTimeOffsets(java.lang.String[] arrStrReferencedTimeOffsets)

Sets temporal points for reference by number of seconds after start of data.

Parameters:

arrStrReferencedTimeOffsets - String array of Referenced Time Offsets

getReferencedTimeOffsets

public java.lang.String[] getReferencedTimeOffsets()

Return temporal points for reference by number of seconds after start of data.

Returns:

String - array of Referenced Time Offsets

setReferencedDatetime

public void setReferencedDatetime(java.lang.String[] arrStrReferencedDatetime)

Sets temporal points for reference by absolute time.

Parameters:

arrStrReferencedDatetime - String array of Referenced Date time

getReferencedDatetime

public java.lang.String[] getReferencedDatetime()

Return temporal points for reference by absolute time.

Returns:

String - value of Referenced Date time

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Temporal Coordinates 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 Temporal Coordinates 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 Temporal Coordinates 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.