com.luciad.reference

LuciadLightspeedClass TLcdAxisInformation

java.lang.Object

com.luciad.reference.TLcdAxisInformation

All Implemented Interfaces:

Serializable, Cloneable

public class TLcdAxisInformation
extends Object
implements Serializable, Cloneable

Container class that provides information about the axes of a reference system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdAxisInformation.Orientation This enum represents an axis orientation.

Constructor Summary

Constructors

Constructor and Description
TLcdAxisInformation(String aPrefix, Properties properties) Creates a new TLcdAxisInformation using the given Properties.
TLcdAxisInformation(String aAxisName, TLcdAxisInformation.Orientation aOrientation) Creates a new TLcdAxisInformation.

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	equals(Object obj)
String	getAxisName() Returns the human-readable axis name.
TLcdAxisInformation.Orientation	getOrientation() Returns the orientation of the axis.
int	hashCode()
void	writePropertiesSFCT(String aPrefix, Properties propertiesSFCT)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TLcdAxisInformation

public TLcdAxisInformation(String aPrefix,
                           Properties properties)

Creates a new TLcdAxisInformation using the given Properties.

Parameters:

aPrefix - the prefix to use for the axis properties

properties - the Properties containing the name and orientation of the axes. If the properties do not contain the orientation, Orientation.OTHER will be chosen.

Throws:

IllegalArgumentException - if an error occurs during the property retrieval.

See Also:

writePropertiesSFCT(String, java.util.Properties)

TLcdAxisInformation

public TLcdAxisInformation(String aAxisName,
                           TLcdAxisInformation.Orientation aOrientation)

Creates a new TLcdAxisInformation.

Parameters:

aAxisName - the name of the axis.

aOrientation - the orientation of the axis.

Method Detail

getAxisName

public String getAxisName()

Returns the human-readable axis name.

Returns:

the name of the axis name.

getOrientation

public TLcdAxisInformation.Orientation getOrientation()

Returns the orientation of the axis. The orientation can be one of NORTH, SOUTH, EAST, WEST, UP, DOWN and OTHER.

Returns:

the orientation of the axis.

writePropertiesSFCT

public void writePropertiesSFCT(String aPrefix,
                                Properties propertiesSFCT)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Object clone()

Overrides:

clone in class Object