xml-clothoid
This is a non-composite/composite builder that constructs a clothoid geometry. The following clothoid definition is supported:
builder type: non-composite/composite, accepts point geometries in composite mode
geometry constructed: clothoid geometry
data parameters:
Data Name |
Value |
Required/ |
---|---|---|
data-string |
The coordinate data string denotes the start, and (optionally) end and intersection points. The coordinate data may be received as point geometries. These points can be named or unnamed. The named point geometries can also be received in any order: their names must be one of “start, end”, or “pi”. If the point geometries are unnamed, then the order of the points is significant: the first point received is assumed as the start point, the next point as the end point, and the last point as the point of intersection. Use the “point-order” data parameter to change this. Notes:
|
Optional if the points are to be passed in as point geometries; otherwise Required |
point-order |
Specifies which order points should be received in when they are unnamed. Range: start-end-pi | start-pi-end Default: start-end-pi |
Optional |
start-curvature / start-radius |
The curvature at the start of the clothoid must be specified as either a curvature (start-curvature) or a radius (start-radius). Range: A positive real number. Default: There are no default values. |
Required |
end-curvature / end-radius |
The curvature at the end of the clothoid must be specified as either a curvature (end-curvature) or a radius (end-radius). |
Required |
length |
The length of the clothoid. |
Required |
start-angle |
The angle that aligns with the start-tangent of the clothoid. |
Optional, if POI is specified, otherwise required |
start-angle_uom |
Specifies whether the start angle is in degrees or radians. Range: deg | degree | rad | radians Default: deg |
Optional |
direction |
Specifies the traversal direction from the start to the end point of the elliptical arc. Range: cw | ccw Default: There are no default values |
Optional |
axis-order |
Indicates the axis for a coordinate. Range: A permutation of the numbers 1..N, where N is the number of dimensions. Each number is separated by a comma “,”. Default: “1,2,...,N” |
Optional; used only if data-string is specified |
axis-separator |
The string separating each axis of a coordinate in the Range: String | “whitespace” – this includes the tab, newline, and space characters. Default: “,” |
Optional; used only if data-string is specified |
coord-separator |
The string separating each coordinate in the Range: String Default: “whitespace” – this includes the tab, newline, and space characters. |
Optional; used only if data-string is specified |
allow-mixed-dimensions |
This allows the datastring to process coordinates with differing dimensions. Range: true, false Default: false |
Optional; used only if data-string is specified |
decimal |
The string representing the decimal point for each real number in the data-string. Range: String Default: “.” |
Optional; used only if data-string is specified |
coordinate-system |
Specifies the coordinate system name. If the expression sequence for the coordinate-system evaluates to the empty string, then the coordinate system for the feature being built will not be set. Range: String |
Optional |
demote-incomplete-geometry |
This optional data parameter allows the xml-clothoid geometry builder to return a non-geometrical object when no data-string is given or when the value of the data-string is the empty string. Range: false | true Default: false |
Optional |
incomplete-geometry-traits |
This optional data parameter takes effect only when the demote-incomplete-geometry data parameter is set to true. This parameter lists the xml-elliptical-arc data parameters that should be loaded into the demoted arc geometry as traits. For example, when this geometry builder fails to construct an arc and demote-incomplete-geometry is set to true and the value for this parameter is set to “radius direction”, then the builder will construct a null geometry with radius and direction traits. Range: whitespace-separated list of arc data parameter names Default: There are no default values. |
Optional |
name |
Specifies the geometry’s name. Range: String |
Optional |