Share

Alignment Methods

The Alignment type exposes the following members.

Methods

 NameDescription
Public methodComputeFingerPrint Compute FingerPrint of the Entity.
(Inherited from Entity)
Public methodCopyToSameSite Copies the Alignment to the same Site as this Alignment. Calling this method copies all children profiles, profile views and sample line group with this alignment as well.
Public methodCopyToSite(ObjectId) Copies the Alignment to another specified Site. Specifying ObjectId.Null to copy it to siteless. Calling this method copies all children profiles, profile views and sample line group with this alignment as well.
Public methodCopyToSite(String) Copies the Alignment to another specified Site. Specifying "" to copy it to siteless. Calling this method copies all children profiles, profile views and sample line group with this alignment as well.
Public methodStatic memberCreate(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId) Creates an Alignment without geometry information.
Public methodStatic memberCode exampleCreate(CivilDocument, String, String, String, String, String) Creates an Alignment without geometry information.
Public methodStatic memberCreate(CivilDocument, PolylineOptions, String, ObjectId, ObjectId, ObjectId, ObjectId) Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
Public methodStatic memberCode exampleCreate(CivilDocument, PolylineOptions, String, String, String, String, String) Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
Public methodStatic memberCreate(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType) Creates an Alignment without geometry information, with Alignment Type.
Public methodStatic memberCreate(CorridorFeatureLine, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType) Creates an Alignment from the specified CorridorFeatureLine.
Public methodStatic memberCreateConnectedAlignment Creates an connected alignment.
Public methodCode exampleCreateOffsetAlignment(Double)Obsolete.
Creates an offset Alignment from the current alignment, returns the offset Alignment ObjectId. A positive value to create an offset alignment to the right side and negative to the left side.
Public methodStatic memberCreateOffsetAlignment(String, ObjectId, Double, ObjectId) Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(Database, String, String, Double, String) Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(String, ObjectId, Double, ObjectId, Double, Double) Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(Database, String, String, Double, String, Double, Double) Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
Public methodDistanceToAlignment(Double, Alignment, Double, Double) Computes the distance to another Alignment. If the target Alignment crosses the current Alignment, this method checks the distance to the target Alignment on both sides, and returns the shorter distance.
Public methodDistanceToAlignment(Double, Alignment, AlignmentSide, Double, Double) Computes the distance to another Alignment, specifying the side of current Alignment to look for the target Alignment.
Public methodGetAlignmentLabelGroupIds Gets the ObjectIdCollection of the Alignment's label group.
Public methodGetAlignmentLabelIds Gets the ObjectIdCollection of the Alignment's labels.
Public methodGetChildOffsetAlignmentIds Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
Public methodGetChildOffsetAlignmentIds(Boolean) Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
Public methodGetCrossSlopeAtStation Gets the cross slope value at the specified station for the indicated segment type.
Public methodGetInstantaneousRadius Returns the instantaneous radius at the specified station.
Public methodGetLabelGroupIdsObsolete.
Gets the ObjectIdCollection of the Alignment's label group.
Public methodGetLabelIdsObsolete.
Gets the ObjectIdCollection of the Alignment's labels.
Public methodStatic memberGetNextUniqueName Gets a string indicating a unique name for the Alignment. The input string could be a name template.
Public methodGetPolyline Gets a polyline from the Alignment geometry.
Public methodCode exampleGetProfileIds Gets the ObjectIdCollection of all profiles belonging to this Alignment.
Public methodGetProfileViewIds Gets the ObjectIdCollection of all profile views belonging to this Alignment.
Public methodCode exampleGetReferenceInfo For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity)
Public methodGetRegionsObsolete.
Gets the regions, which are included in offset alignment or curb return.
Public methodGetSampleLineGroupIds Gets the ObjectIdCollection of all sample line groups belonging to this Alignment.
Public methodCode exampleGetStationSet(StationTypes) Gets the station set according to the StationType.
Public methodCode exampleGetStationSet(StationTypes, Double) Gets the station set according to the StationType and interval.
Public methodCode exampleGetStationSet(StationTypes, Double, Double) Gets the station set according to the StationType and intervals.
Public methodGetStationSet(StationTypes, Double, Double, Double, Double) Gets the station set according to the StationType, intervals and station range.
Public methodGetStationStringWithEquations Gets a string indicating the station of an Alignment using the Station equations.
Public methodGetSuperelevationViewIds Gets the ObjectIdCollection of all Superelevation views belonging to this Alignment.
Public methodImportLabelSet(ObjectId) Takes the contents of the AlignmentLabelSetStyle template and copies its data into the database object.
Public methodImportLabelSet(String) Takes the contents of the AlignmentLabelSetStyle template and copies its data into the Database object.
Public methodPointLocation(Double, Double, Double, Double) Returns the easting and northing of a point on an Alignment given a station and an offset for the Alignment.
Public methodPointLocation(Double, Double, Double, Double, Double, Double) Given station and offset values, returns the easting, northing, and bearing values at that point on the Alignment.
Public methodReverse Reverse the Alignment direction.
Public methodStationOffset(Double, Double, Double, Double) Returns the station and offset on an Alignment at given easting and northing values.
Public methodStationOffset(Double, Double, Double, Double, Double) Returns the nearest station and offset on an Alignment at given easting, northing and tolerance values.
Public methodStationOffsetAcceptOutOfRange(Double, Double, Double, Double, Boolean) Returns the station and offset on an Alignment at given easting and northing values, the same as the StationOffset method. Whereas the StationOffset method throws an exception if the easting and northing are out of Alignment range, this one does not and instead returns either the starting or ending station as the station, and the offset returned is the distance between the easting and northing point and the first or last station.
Public methodStationOffsetAcceptOutOfRange(Double, Double, Double, Double, Double, Boolean) Returns the station and offset on an Alignment at given easting and northing values, the same as the StationOffset method. Whereas the StationOffset method throws an exception if the easting and northing are out of Alignment range, this one does not and instead returns either the starting or ending station as the station, and the offset returned is the distance between the easting and northing point and the first or last station.
Public methodTrackDistanceToAlignment(Double, NullableDouble, ObjectId, NullableDouble, TrackDistanceCalculationMode) Computes the distance between tracks of two alignments.
Public methodTrackDistanceToAlignment(ListDouble, NullableDouble, ObjectId, NullableDouble, TrackDistanceCalculationMode) Computes the distance between tracks of two alignments.
Public methodTrackDistanceToAlignment(Double, Double, NullableDouble, ObjectId, NullableDouble, TrackDistanceCalculationMode) Computes the minimum distance between tracks of two alignments.
Public methodUpdate Updates the OffsetAlignmentInfo for an offset alignment object.

See Also

Reference

Was this information helpful?