public class TLcdAIXM51VerticalStructurePart extends TLcdAIXM51AbstractPropertiesWithSchedule implements ILcdExtrudedShape
ILcdExtrudedShape
interface.Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
ANNOTATION_PROPERTY
Data property that maps to the
annotation element. |
static TLcdDataProperty |
CONSTRUCTION_STATUS_PROPERTY
Data property that maps to the
constructionStatus element. |
static TLcdDataProperty |
DESIGNATOR_PROPERTY
Data property that maps to the
designator element. |
static TLcdDataProperty |
EXTENSION_PROPERTY
Data property that maps to the
extension element. |
static TLcdDataProperty |
FRANGIBLE_PROPERTY
Data property that maps to the
frangible element. |
static TLcdDataProperty |
HORIZONTAL_PROJECTION_PROPERTY
Data property that maps to the choice between the
horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements. |
static TLcdDataProperty |
LIGHTING_PROPERTY
Data property that maps to the
lighting element. |
static TLcdDataProperty |
MARKING_FIRST_COLOUR_PROPERTY
Data property that maps to the
markingFirstColour element. |
static TLcdDataProperty |
MARKING_PATTERN_PROPERTY
Data property that maps to the
markingPattern element. |
static TLcdDataProperty |
MARKING_SECOND_COLOUR_PROPERTY
Data property that maps to the
markingSecondColour element. |
static TLcdDataProperty |
MOBILE_PROPERTY
Data property that maps to the
mobile element. |
static TLcdDataProperty |
SPECIAL_DATE_AUTHORITY_PROPERTY
Data property that maps to the
specialDateAuthority element. |
static TLcdDataProperty |
TIME_INTERVAL_PROPERTY
Data property that maps to the
timeInterval element. |
static TLcdDataProperty |
TYPE_PROPERTY
Data property that maps to the
type element. |
static TLcdDataProperty |
VERTICAL_EXTENT_ACCURACY_PROPERTY
Data property that maps to the
verticalExtentAccuracy element. |
static TLcdDataProperty |
VERTICAL_EXTENT_PROPERTY
Data property that maps to the
verticalExtent element. |
static TLcdDataProperty |
VISIBLE_MATERIAL_PROPERTY
Data property that maps to the
visibleMaterial element. |
DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY
Constructor and Description |
---|
TLcdAIXM51VerticalStructurePart() |
TLcdAIXM51VerticalStructurePart(TLcdDataType aType) |
Modifier and Type | Method and Description |
---|---|
boolean |
contains2D(double aX,
double aY)
Checks whether this
ILcdShape contains the given point in
the 2D space. |
boolean |
contains2D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 2D space. |
boolean |
contains3D(double aX,
double aY,
double aZ)
Checks whether this
ILcdShape contains the given point in
the 3D space. |
boolean |
contains3D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 3D space. |
List<TLcdAIXM51Note> |
getAnnotation()
Gets the value of the
ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances. |
ILcdShape |
getBaseShape()
Returns an
ILcdShapeList containing the horizontal projections of this part. |
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
TLcdAIXM51CodeStatusConstruction |
getConstructionStatus()
Returns the role value contained in the value of the
CONSTRUCTION_STATUS_PROPERTY property. |
String |
getDesignator()
Returns the role value contained in the value of the
DESIGNATOR_PROPERTY property. |
List<TLcdAIXM51AbstractExtension> |
getExtension()
Gets the value of the
EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances. |
ILcdPoint |
getFocusPoint()
Returns the focus point of this
ILcdShape . |
TLcdAIXM51CodeYesNo |
getFrangible()
Returns the role value contained in the value of the
FRANGIBLE_PROPERTY property. |
TLcdGML32AbstractGeometricPrimitive |
getHorizontalProjection()
Returns the value of the property that maps to the choice between the
horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements. |
List<TLcdAIXM51LightElement> |
getLighting()
Gets the value of the
LIGHTING_PROPERTY property adapted to a list of TLcdAIXM51LightElement instances. |
TLcdAIXM51CodeColour |
getMarkingFirstColour()
Returns the role value contained in the value of the
MARKING_FIRST_COLOUR_PROPERTY property. |
TLcdAIXM51CodeVerticalStructureMarking |
getMarkingPattern()
Returns the role value contained in the value of the
MARKING_PATTERN_PROPERTY property. |
TLcdAIXM51CodeColour |
getMarkingSecondColour()
Returns the role value contained in the value of the
MARKING_SECOND_COLOUR_PROPERTY property. |
double |
getMaximumZ()
Returns the maximum Z value, which corresponds to the vertical extent added to the minimum Z value.
|
double |
getMinimumZ()
Returns the minimum Z value
|
TLcdAIXM51CodeYesNo |
getMobile()
Returns the role value contained in the value of the
MOBILE_PROPERTY property. |
List<TLcdAIXM51Feature<TLcdAIXM51OrganisationAuthorityTimeSlice>> |
getSpecialDateAuthority()
Gets the value of the
SPECIAL_DATE_AUTHORITY_PROPERTY property adapted to a list of TLcdAIXM51Feature instances. |
List<TLcdAIXM51Timesheet> |
getTimeInterval()
Gets the value of the
TIME_INTERVAL_PROPERTY property adapted to a list of TLcdAIXM51Timesheet instances. |
TLcdAIXM51CodeVerticalStructure |
getType()
Returns the role value contained in the value of the
TYPE_PROPERTY property. |
TLcdAIXM51ValDistance |
getVerticalExtent()
Returns the value of the property that maps to the
verticalExtent element. |
TLcdAIXM51ValDistance |
getVerticalExtentAccuracy()
Returns the value of the property that maps to the
verticalExtentAccuracy element. |
TLcdAIXM51CodeVerticalStructureMaterial |
getVisibleMaterial()
Returns the role value contained in the value of the
VISIBLE_MATERIAL_PROPERTY property. |
void |
setConstructionStatus(TLcdAIXM51CodeStatusConstruction aValue)
Sets the value of the property that maps to the
constructionStatus element. |
void |
setDesignator(String aValue)
Sets the value of the property that maps to the
designator element. |
void |
setFrangible(TLcdAIXM51CodeYesNo aValue)
Sets the value of the property that maps to the
frangible element. |
void |
setHorizontalProjection(TLcdGML32AbstractGeometricPrimitive aValue)
Sets the value of the property that maps to the choice between the
horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements. |
void |
setMarkingFirstColour(TLcdAIXM51CodeColour aValue)
Sets the value of the property that maps to the
markingFirstColour element. |
void |
setMarkingPattern(TLcdAIXM51CodeVerticalStructureMarking aValue)
Sets the value of the property that maps to the
markingPattern element. |
void |
setMarkingSecondColour(TLcdAIXM51CodeColour aValue)
Sets the value of the property that maps to the
markingSecondColour element. |
void |
setMobile(TLcdAIXM51CodeYesNo aValue)
Sets the value of the property that maps to the
mobile element. |
void |
setType(TLcdAIXM51CodeVerticalStructure aValue)
Sets the value of the property that maps to the
type element. |
void |
setVerticalExtent(TLcdAIXM51ValDistance aValue)
Sets the value of the property that maps to the
verticalExtent element. |
void |
setVerticalExtentAccuracy(TLcdAIXM51ValDistance aValue)
Sets the value of the property that maps to the
verticalExtentAccuracy element. |
void |
setVisibleMaterial(TLcdAIXM51CodeVerticalStructureMaterial aValue)
Sets the value of the property that maps to the
visibleMaterial element. |
getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
clone
public static final TLcdDataProperty TIME_INTERVAL_PROPERTY
timeInterval
element.
The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51Timesheet>>
.public static final TLcdDataProperty ANNOTATION_PROPERTY
annotation
element.
The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51Note>>
.public static final TLcdDataProperty SPECIAL_DATE_AUTHORITY_PROPERTY
specialDateAuthority
element.
The possible values for this property are instances of List<TLcdAIXM51FeatureAssociation<TLcdAIXM51OrganisationAuthorityTimeSlice>>
.public static final TLcdDataProperty VERTICAL_EXTENT_PROPERTY
verticalExtent
element.
The possible values for this property are instances of TLcdAIXM51ValDistance
.public static final TLcdDataProperty VERTICAL_EXTENT_ACCURACY_PROPERTY
verticalExtentAccuracy
element.
The possible values for this property are instances of TLcdAIXM51ValDistance
.public static final TLcdDataProperty TYPE_PROPERTY
type
element.
The possible values for this property are the public QName
constants defined in this class.public static final TLcdDataProperty CONSTRUCTION_STATUS_PROPERTY
constructionStatus
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeStatusConstruction>
.public static final TLcdDataProperty MARKING_PATTERN_PROPERTY
markingPattern
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalStructureMarking>
.public static final TLcdDataProperty MARKING_FIRST_COLOUR_PROPERTY
markingFirstColour
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeColour>
.public static final TLcdDataProperty MARKING_SECOND_COLOUR_PROPERTY
markingSecondColour
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeColour>
.public static final TLcdDataProperty MOBILE_PROPERTY
mobile
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeYesNo>
.public static final TLcdDataProperty FRANGIBLE_PROPERTY
frangible
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeYesNo>
.public static final TLcdDataProperty VISIBLE_MATERIAL_PROPERTY
visibleMaterial
element.
The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalStructureMaterial>
.public static final TLcdDataProperty DESIGNATOR_PROPERTY
designator
element.
The possible values for this property are instances of TLcdAIXM51Optional<String>
.public static final TLcdDataProperty HORIZONTAL_PROJECTION_PROPERTY
horizontalProjection_location
and horizontalProjection_linearExtent
and horizontalProjection_surfaceExtent
elements.
The possible values for this property are instances of
public static final TLcdDataProperty LIGHTING_PROPERTY
lighting
element.
The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51LightElement>>
.public static final TLcdDataProperty EXTENSION_PROPERTY
extension
element.
The possible values for this property are instances of List<TLcdAIXM51Link<TLcdAIXM51AbstractExtension>>
.public TLcdAIXM51VerticalStructurePart()
public TLcdAIXM51VerticalStructurePart(TLcdDataType aType)
public ILcdShape getBaseShape()
ILcdShapeList
containing the horizontal projections of this part. The ILcdShapeList
will contain the linearExtent, location and surfaceExtent, if they exist.getBaseShape
in interface ILcdExtrudedShape
public double getMinimumZ()
getMinimumZ
in interface ILcdExtrudedShape
public double getMaximumZ()
The value is converted to metres before being returned.
getMaximumZ
in interface ILcdExtrudedShape
public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.public boolean contains2D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 2D space.
Only the first two dimensions of the ILcdShape
and the ILcdPoint
are considered.contains2D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains2D(double, double)
public boolean contains2D(double aX, double aY)
ILcdShape
ILcdShape
contains the given point in
the 2D space. Only the first two dimensions of the ILcdShape
are considered.contains2D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public boolean contains3D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 3D space.contains3D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains3D(double, double, double)
public boolean contains3D(double aX, double aY, double aZ)
ILcdShape
ILcdShape
contains the given point in
the 3D space.contains3D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.aZ
- the z coordinate of the point.public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.
If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points)
the return value is unspecified.
It is highly recommended to return an undefined
bounds.
You can create undefined bounds using the default constructors
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public List<TLcdAIXM51Timesheet> getTimeInterval()
TIME_INTERVAL_PROPERTY
property adapted to a list of TLcdAIXM51Timesheet
instances.
A component of the schedule.
getTimeInterval
in class TLcdAIXM51AbstractPropertiesWithSchedule
TIME_INTERVAL_PROPERTY
property adapted to a list of TLcdAIXM51Timesheet
instances.TLcdAIXM51Property
public List<TLcdAIXM51Note> getAnnotation()
ANNOTATION_PROPERTY
property adapted to a list of TLcdAIXM51Note
instances.getAnnotation
in class TLcdAIXM51AbstractPropertiesWithSchedule
ANNOTATION_PROPERTY
property adapted to a list of TLcdAIXM51Note
instances.TLcdAIXM51Property
public List<TLcdAIXM51Feature<TLcdAIXM51OrganisationAuthorityTimeSlice>> getSpecialDateAuthority()
SPECIAL_DATE_AUTHORITY_PROPERTY
property adapted to a list of TLcdAIXM51Feature
instances.
Indicates that the SpecialDates associated with the related OrganisationAuthority are applicable to the schedule definition.
getSpecialDateAuthority
in class TLcdAIXM51AbstractPropertiesWithSchedule
SPECIAL_DATE_AUTHORITY_PROPERTY
property adapted to a list of TLcdAIXM51Feature
instances.TLcdAIXM51FeatureAssociation
public TLcdAIXM51ValDistance getVerticalExtent()
verticalExtent
element.
The extent of the vertical structure part.
VERTICAL_EXTENT_PROPERTY
property.public void setVerticalExtent(TLcdAIXM51ValDistance aValue)
verticalExtent
element.
The extent of the vertical structure part.
aValue
- the value to set for the VERTICAL_EXTENT_PROPERTY
property.public TLcdAIXM51ValDistance getVerticalExtentAccuracy()
verticalExtentAccuracy
element.
Accuracy of the value of the declared vertical extent.
VERTICAL_EXTENT_ACCURACY_PROPERTY
property.public void setVerticalExtentAccuracy(TLcdAIXM51ValDistance aValue)
verticalExtentAccuracy
element.
Accuracy of the value of the declared vertical extent.
aValue
- the value to set for the VERTICAL_EXTENT_ACCURACY_PROPERTY
property.public TLcdAIXM51CodeVerticalStructure getType()
TYPE_PROPERTY
property. Returns null
if the value of the TYPE_PROPERTY
property is null
.
The possible values for this property are the public QName
constants defined in this class.
A code indicating the type of vertical structure, such as building, tower, cable, etc.
TYPE_PROPERTY
property.TLcdAIXM51Optional
public void setType(TLcdAIXM51CodeVerticalStructure aValue)
type
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the TYPE_PROPERTY
property is set to null
.
The possible values for this property are the public QName
constants defined in this class.
A code indicating the type of vertical structure, such as building, tower, cable, etc.
aValue
- the role value to set for the TYPE_PROPERTY
property.public TLcdAIXM51CodeStatusConstruction getConstructionStatus()
CONSTRUCTION_STATUS_PROPERTY
property. Returns null
if the value of the CONSTRUCTION_STATUS_PROPERTY
property is null
.
This property enables the provision of information about the construction of the man-made object that constitutes the vertical structure.
CONSTRUCTION_STATUS_PROPERTY
property.TLcdAIXM51Optional
public void setConstructionStatus(TLcdAIXM51CodeStatusConstruction aValue)
constructionStatus
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the CONSTRUCTION_STATUS_PROPERTY
property is set to null
.
This property enables the provision of information about the construction of the man-made object that constitutes the vertical structure.
aValue
- the role value to set for the CONSTRUCTION_STATUS_PROPERTY
property.public TLcdAIXM51CodeVerticalStructureMarking getMarkingPattern()
MARKING_PATTERN_PROPERTY
property. Returns null
if the value of the MARKING_PATTERN_PROPERTY
property is null
.
The general layout of the external paint or another marking element, intended to increase the visibility of the vertical structure.
MARKING_PATTERN_PROPERTY
property.TLcdAIXM51Optional
public void setMarkingPattern(TLcdAIXM51CodeVerticalStructureMarking aValue)
markingPattern
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the MARKING_PATTERN_PROPERTY
property is set to null
.
The general layout of the external paint or another marking element, intended to increase the visibility of the vertical structure.
aValue
- the role value to set for the MARKING_PATTERN_PROPERTY
property.public TLcdAIXM51CodeColour getMarkingFirstColour()
MARKING_FIRST_COLOUR_PROPERTY
property. Returns null
if the value of the MARKING_FIRST_COLOUR_PROPERTY
property is null
.
The principal colour of the marking.
MARKING_FIRST_COLOUR_PROPERTY
property.TLcdAIXM51Optional
public void setMarkingFirstColour(TLcdAIXM51CodeColour aValue)
markingFirstColour
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the MARKING_FIRST_COLOUR_PROPERTY
property is set to null
.
The principal colour of the marking.
aValue
- the role value to set for the MARKING_FIRST_COLOUR_PROPERTY
property.public TLcdAIXM51CodeColour getMarkingSecondColour()
MARKING_SECOND_COLOUR_PROPERTY
property. Returns null
if the value of the MARKING_SECOND_COLOUR_PROPERTY
property is null
.
The secondary colour for the marking.
MARKING_SECOND_COLOUR_PROPERTY
property.TLcdAIXM51Optional
public void setMarkingSecondColour(TLcdAIXM51CodeColour aValue)
markingSecondColour
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the MARKING_SECOND_COLOUR_PROPERTY
property is set to null
.
The secondary colour for the marking.
aValue
- the role value to set for the MARKING_SECOND_COLOUR_PROPERTY
property.public TLcdAIXM51CodeYesNo getMobile()
MOBILE_PROPERTY
property. Returns null
if the value of the MOBILE_PROPERTY
property is null
.
A flag indicating whether the vertical structure is expected to move around its nominal location. The accuracy property of the related Point, Surface or Point can be used to provide the maximum displacement range.
MOBILE_PROPERTY
property.TLcdAIXM51Optional
public void setMobile(TLcdAIXM51CodeYesNo aValue)
mobile
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the MOBILE_PROPERTY
property is set to null
.
A flag indicating whether the vertical structure is expected to move around its nominal location. The accuracy property of the related Point, Surface or Point can be used to provide the maximum displacement range.
aValue
- the role value to set for the MOBILE_PROPERTY
property.public TLcdAIXM51CodeYesNo getFrangible()
FRANGIBLE_PROPERTY
property. Returns null
if the value of the FRANGIBLE_PROPERTY
property is null
.
Boolean indicating whether the obstruction is easily broken
FRANGIBLE_PROPERTY
property.TLcdAIXM51Optional
public void setFrangible(TLcdAIXM51CodeYesNo aValue)
frangible
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the FRANGIBLE_PROPERTY
property is set to null
.
Boolean indicating whether the obstruction is easily broken
aValue
- the role value to set for the FRANGIBLE_PROPERTY
property.public TLcdAIXM51CodeVerticalStructureMaterial getVisibleMaterial()
VISIBLE_MATERIAL_PROPERTY
property. Returns null
if the value of the VISIBLE_MATERIAL_PROPERTY
property is null
.
The type(s) of material that compose the load-bearing structure and/or exterior facing of a vertical construction (for example: a building or non-building structure).
VISIBLE_MATERIAL_PROPERTY
property.TLcdAIXM51Optional
public void setVisibleMaterial(TLcdAIXM51CodeVerticalStructureMaterial aValue)
visibleMaterial
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the VISIBLE_MATERIAL_PROPERTY
property is set to null
.
The type(s) of material that compose the load-bearing structure and/or exterior facing of a vertical construction (for example: a building or non-building structure).
aValue
- the role value to set for the VISIBLE_MATERIAL_PROPERTY
property.public String getDesignator()
DESIGNATOR_PROPERTY
property. Returns null
if the value of the DESIGNATOR_PROPERTY
property is null
.
An alphanumeric code by which the structure is identified locally.
DESIGNATOR_PROPERTY
property.TLcdAIXM51Optional
public void setDesignator(String aValue)
designator
element. to a new instance of the association class TLcdAIXM51Optional
initialized with the given role value. In case the given role value is null
, the DESIGNATOR_PROPERTY
property is set to null
.
An alphanumeric code by which the structure is identified locally.
aValue
- the role value to set for the DESIGNATOR_PROPERTY
property.public TLcdGML32AbstractGeometricPrimitive getHorizontalProjection()
horizontalProjection_location
and horizontalProjection_linearExtent
and horizontalProjection_surfaceExtent
elements.
The possible values for this property are instances of
HORIZONTAL_PROJECTION_PROPERTY
property.TLcdGML32AbstractGeometricPrimitive
public void setHorizontalProjection(TLcdGML32AbstractGeometricPrimitive aValue)
horizontalProjection_location
and horizontalProjection_linearExtent
and horizontalProjection_surfaceExtent
elements.
The possible values for this property are instances of
aValue
- the value to set for the HORIZONTAL_PROJECTION_PROPERTY
property.public List<TLcdAIXM51LightElement> getLighting()
LIGHTING_PROPERTY
property adapted to a list of TLcdAIXM51LightElement
instances.
An element of the vertical structure part lighting.
LIGHTING_PROPERTY
property adapted to a list of TLcdAIXM51LightElement
instances.TLcdAIXM51Property
public List<TLcdAIXM51AbstractExtension> getExtension()
EXTENSION_PROPERTY
property adapted to a list of TLcdAIXM51AbstractExtension
instances.EXTENSION_PROPERTY
property adapted to a list of TLcdAIXM51AbstractExtension
instances.TLcdAIXM51Link