cdac.medinfo.sdk.dcm30_04.baselibs

Class MatingFeatureDegreeofFreedomSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.MatingFeatureDegreeofFreedomSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class MatingFeatureDegreeofFreedomSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Mating Feature Degree ofFreedom Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short	getDegreeofFreedomID() Retrieves Degree of Freedom ID.
java.lang.String	getDegreeofFreedomType() Return type of Degree of Freedom.
double[]	getRangeofFreedom() Retrieves the Range of Freedom.
double[]	getThreeDDegreeOfFreedomAxis() Retrieves the 3D Degree Of Freedom Axis.
TwoDDegreeOfFreedomSequence	getTwoDDegreeOfFreedomSequence() Retrieves pre-initialized object of 2D Degree Of Freedom 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.
void	setDegreeofFreedomID(short shDegreeofFreedomID) Sets Degree of Freedom ID.
void	setDegreeofFreedomType(EnumDegreeofFreedomType enumDegreeofFreedomType) Sets type of Degree of Freedom.
void	setRangeofFreedom(double[] dblArrRangeofFreedom) Sets the Range of Freedom.
void	setThreeDDegreeOfFreedomAxis(double[] dblArrThreeDDegreeOfFreedomAxis) Sets the 3D Degree Of Freedom Axis.
boolean	validateForModule() Validates all the attributes in MatingFeatureDegreeofFreedomSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in MatingFeatureDegreeofFreedomSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setDegreeofFreedomID

public void setDegreeofFreedomID(short shDegreeofFreedomID)

Sets Degree of Freedom ID. Numeric ID of the degree of freedom.

Parameters:

shDegreeofFreedomID - short value of Degree of Freedom ID

getDegreeofFreedomID

public short getDegreeofFreedomID()

Retrieves Degree of Freedom ID. Numeric ID of the degree of freedom.

Returns:

short - short value of Degree of Freedom ID

setDegreeofFreedomType

public void setDegreeofFreedomType(EnumDegreeofFreedomType enumDegreeofFreedomType)

Sets type of Degree of Freedom. Indicates the type of the degree of freedom. Defined Terms: 1) TRANSLATION. 2) ROTATION.

Parameters:

enumDegreeofFreedomType - enum value of Degree of Freedom Type.

getDegreeofFreedomType

public java.lang.String getDegreeofFreedomType()

Return type of Degree of Freedom. Indicates the type of the degree of freedom.

Returns:

String - value of Degree of Freedom Type.

getTwoDDegreeOfFreedomSequence

public TwoDDegreeOfFreedomSequence getTwoDDegreeOfFreedomSequence()

Retrieves pre-initialized object of 2D Degree Of Freedom 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:

TwoDDegreeOfFreedomSequence - instance of TwoDDegreeOfFreedomSequence.

setThreeDDegreeOfFreedomAxis

public void setThreeDDegreeOfFreedomAxis(double[] dblArrThreeDDegreeOfFreedomAxis)

Sets the 3D Degree Of Freedom Axis.

Parameters:

dblArrThreeDDegreeOfFreedomAxis - Double value of 3D Degree Of Freedom Axis.

getThreeDDegreeOfFreedomAxis

public double[] getThreeDDegreeOfFreedomAxis()

Retrieves the 3D Degree Of Freedom Axis.

Returns:

double - double value of 3D Degree Of Freedom Axis.

setRangeofFreedom

public void setRangeofFreedom(double[] dblArrRangeofFreedom)

Sets the Range of Freedom. Two floating point numbers defining a value range for this degree of freedom.

Parameters:

dblArrRangeofFreedom - Double value of Range of Freedom

getRangeofFreedom

public double[] getRangeofFreedom()

Retrieves the Range of Freedom. Two floating point numbers defining a value range for this degree of freedom.

Returns:

double - double value of Range of Freedom