uavsim.datatypes
Class Ring

java.lang.Object
  uavsim.datatypes.Ring

public class Ring
extends java.lang.Object

Defines a ring as inner and outer radii.

Author:

Dan Tappan [26.06.11]

Field Summary

private Radius	_radiusInner the inner radius
private Radius	_radiusOuter the outer radius

Constructor Summary

Ring(Radius radiusInner, Radius radiusOuter)
Creates a ring descriptor.

Method Summary

Radius	getRadiusInner() Gets the inner radius.
Radius	getRadiusMidpoint() Determines the radius halfway between the outer and inner radii.
Radius	getRadiusOuter() Gets the outer radius.
Radius	getWidth() Determines the width of the ring as the difference between the outer and inner radii.
private void	setRadiusInner(Radius radiusInner) Sets the inner radius.
private void	setRadiusOuter(Radius radiusOuter) Sets the outer radius.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_radiusInner

private Radius _radiusInner

the inner radius

_radiusOuter

private Radius _radiusOuter

the outer radius

Constructor Detail

Ring

public Ring(Radius radiusInner,
            Radius radiusOuter)

Creates a ring descriptor.

Parameters:

radiusInner - - the inner radius, which must not be greater than the outer

radiusOuter - - the outer radius

Method Detail

getRadiusInner

public Radius getRadiusInner()

Gets the inner radius.

Returns:

the radius

getRadiusMidpoint

public Radius getRadiusMidpoint()

Determines the radius halfway between the outer and inner radii.

Returns:

the radius

getRadiusOuter

public Radius getRadiusOuter()

Gets the outer radius.

Returns:

the radius

getWidth

public Radius getWidth()

Determines the width of the ring as the difference between the outer and inner radii.

Returns:

the width

setRadiusInner

private void setRadiusInner(Radius radiusInner)

Sets the inner radius.

Parameters:

radiusInner - - the inner radius

setRadiusOuter

private void setRadiusOuter(Radius radiusOuter)

Sets the outer radius.

Parameters:

radiusOuter - - the outer radius

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object