public class TLcdRouteSegment extends Object implements ILcdEditableRouteSegment
ILcdRouteSegment
.Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
BEGIN_POINT_PROPERTY
The BeginPoint property of the route segment type.
|
static TLcdDataProperty |
END_POINT_PROPERTY
The EndPoint property of the route segment type.
|
static TLcdDataProperty |
SEQUENCE_NUMBER_PROPERTY
The SequenceNumber property of the route segment type.
|
Constructor and Description |
---|
TLcdRouteSegment()
Deprecated.
|
TLcdRouteSegment(TLcdDataType aDataType)
Creates a new instance for the given type.
|
TLcdRouteSegment(TLcdRouteSegment aRouteSegment)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Returns a clone of this
TLcdRouteSegment object. |
ILcdPoint |
getBeginPoint()
Returns the first point of this route segment.
|
TLcdDataType |
getDataType()
Returns the type of this data object.
|
ILcdPoint |
getEndPoint()
Returns the second point of this route segment.
|
ILcdPoint |
getPoint(int i)
Returns the
ILcdPoint at a given index. |
int |
getPointCount()
Returns 2 for a valid route segment with both a begin and end point, 0 otherwise.
|
int |
getSequenceNumber()
Returns the segment number of this route segment.
|
Object |
getValue(String aPropertyName)
Convenience method that returns the value of the property with the given name.
|
Object |
getValue(TLcdDataProperty aProperty)
Returns the value of the given property.
|
boolean |
hasValue(String aPropertyName)
Indicates whether this data object has a value for the given property.
|
boolean |
hasValue(TLcdDataProperty aProperty)
Indicates whether this data object has a value for the given property.
|
void |
setBeginPoint(ILcdPoint aBeginPoint)
Specifies the begin point of this route segment.
|
void |
setEndPoint(ILcdPoint aEndPoint)
Specifies the end point for this route segment.
|
void |
setSequenceNumber(int aSequenceNumber)
Specifies the segment number of this route segment.
|
void |
setValue(String aPropertyName,
Object aValue)
Convenience method that sets the value of the property with the given name.
|
void |
setValue(TLcdDataProperty aProperty,
Object aValue)
Sets the value of the given property for this data object.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPointSFCT, getX, getY, getZ
public static final TLcdDataProperty BEGIN_POINT_PROPERTY
ILcdPoint
.public static final TLcdDataProperty END_POINT_PROPERTY
ILcdPoint
.public static final TLcdDataProperty SEQUENCE_NUMBER_PROPERTY
Integer
.@Deprecated public TLcdRouteSegment()
TLcdRouteSegment(TLcdDataType)
TLcdRouteSegment
starting at the given begin
point and ending at the given end point.public TLcdRouteSegment(TLcdRouteSegment aRouteSegment)
cloneAs3DEditablePoint()
.aRouteSegment
- the routeSegment to be copied into a new objectpublic TLcdRouteSegment(TLcdDataType aDataType)
aDataType
- the data type of the returned instanceIllegalArgumentException
- if TLcdAISDataTypes.RouteSegment
is not assignable
from the given data typepublic TLcdDataType getDataType()
ILcdDataObject
null
.getDataType
in interface ILcdDataObject
public Object getValue(TLcdDataProperty aProperty)
ILcdDataObject
Returns the value of the given property.
If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).
The property must not be null, and must be declared in the data object's type
or in one of its super types.
Otherwise an IllegalArgumentException
is thrown.
getValue
in interface ILcdDataObject
aProperty
- the property for which the value is to be returnedpublic Object getValue(String aPropertyName)
ILcdDataObject
Convenience method that returns the value of the property with the given name.
If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy). SeeILcdDataObject.getValue(TLcdDataProperty)
for more information.getValue
in interface ILcdDataObject
aPropertyName
- the name of the property of which the value is to be returnedTLcdDataType.getProperty(String)
public void setValue(TLcdDataProperty aProperty, Object aValue)
ILcdDataObject
Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.
The given property must be declared in thedata object's type
or in one of its super types. In
other words, getDataType().getProperties().contains( aProperty ) should always be true.
Otherwise, the implementation should throw an IllegalArgumentException
.setValue
in interface ILcdDataObject
aProperty
- the property for which the value is to be setaValue
- the value to setTLcdDataType.getProperty(String)
public void setValue(String aPropertyName, Object aValue)
ILcdDataObject
Convenience method that sets the value of the property with the given name.
If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy). SeeILcdDataObject.setValue(TLcdDataProperty, Object)
for more information.setValue
in interface ILcdDataObject
aPropertyName
- the name of the property of which the value is to be setaValue
- the value to setpublic boolean hasValue(TLcdDataProperty aProperty)
ILcdDataObject
aProperty
is from the right data type
, and this instance has a value for it: returns true
aProperty
is from the right data type
, and this instance has no value for it: returns false
aProperty
is not from the right data type
: not allowed, you will get IllegalArgumentExceptionaProperty
is null
: not allowed, you will get NullPointerExceptionhasValue
in interface ILcdDataObject
aProperty
- the property for which to return whether a value is present or not.true
if this data object has a value for the given property, false
otherwise.public boolean hasValue(String aPropertyName)
ILcdDataObject
ILcdDataObject.hasValue(TLcdDataProperty)
for more information.hasValue
in interface ILcdDataObject
aPropertyName
- the name of the property for which to return whether a value is present
or not.true
if this data object has a value for the property with the given name,
false
otherwise.public void setSequenceNumber(int aSequenceNumber)
ILcdEditableRouteSegment
setSequenceNumber
in interface ILcdEditableRouteSegment
public void setBeginPoint(ILcdPoint aBeginPoint)
ILcdEditableRouteSegment
setBeginPoint
in interface ILcdEditableRouteSegment
public void setEndPoint(ILcdPoint aEndPoint)
ILcdEditableRouteSegment
setEndPoint
in interface ILcdEditableRouteSegment
public int getSequenceNumber()
ILcdRouteSegment
getSequenceNumber
in interface ILcdRouteSegment
public ILcdPoint getBeginPoint()
ILcdRouteSegment
getBeginPoint
in interface ILcdRouteSegment
public ILcdPoint getEndPoint()
ILcdRouteSegment
getEndPoint
in interface ILcdRouteSegment
public int getPointCount()
getPointCount
in interface ILcdPointList
public ILcdPoint getPoint(int i) throws IndexOutOfBoundsException
ILcdPointList
ILcdPoint
at a given index.getPoint
in interface ILcdPointList
i
- a valid index in the list of ILcdPoint
objects.ILcdPoint
at the given index.IndexOutOfBoundsException
- if the given index is out of bounds.public Object clone()
TLcdRouteSegment
object.
Note: the begin point and end point of the new object
are a clone of the begin and end point of this object.
Other features are a shallow clone.clone
in interface ILcdRouteSegment
clone
in class Object
TLcdRouteSegment
object.