CorridorState Class

Contains a wide array of information about a corridor and methods for determining locations relative to the corridor. Used in the creation of custom subassemblies.

Inheritance Hierarchy

SystemObject
  [T:Autodesk.Civil.CivilWrapper<AeccDbRuntimeState>]
    Autodesk.Civil.RuntimeRuntimeState
      Autodesk.Civil.RuntimeCorridorState

Namespace: Autodesk.Civil.Runtime
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292

Syntax

C++

Copy

public sealed class CorridorState : RuntimeState

Public NotInheritable Class CorridorState
	Inherits RuntimeState

public ref class CorridorState sealed : public RuntimeState

The CorridorState type exposes the following members.

Properties

	Name	Description
	CurrentAlignmentId	Gets the current alignment where Subassembly is being applied.
	CurrentAlignmentIsOffsetAlignment	Returns true if current processing state is along an offset alignment.
	CurrentAssemblyElevation	Returns elevation difference from profile grade line elevation where current assembly is being applied.
	CurrentAssemblyFixedElevation	If the CurrentAssemblyOffsetIsFixed property returns True, this property is the fixed elevation difference of the offset assembly portion from the baseline assembly portion.
	CurrentAssemblyFixedOffset	If the CurrentAssemblyOffsetIsFixed property returns True, this property is the fixed offset distance of the offset assembly portion from the baseline assembly portion.
	CurrentAssemblyId	Gets the ObjectId of the current Assembly being applied.
	CurrentAssemblyName	Gets the name of the current Assembly being applied.
	CurrentAssemblyOffset	Returns offset from baseline alignment where current assembly is being applied.
	CurrentAssemblyOffsetIsFixed	Returns true if current processing state is along offset portion of assembly without offset alignment defined.
	CurrentBaselineId	Gets the current baseline alignment where a Subassembly is being applied.
	CurrentCorridorId	Gets the OjbectId of the current Corridor being applied.
	CurrentCorridorName	Gets the name of the current Corridor being applied.
	CurrentElevation	Gets the current elevation.
	CurrentMacroName	Gets the current macro name. (Inherited from RuntimeState)
	CurrentMacroProject	Gets the current macro project. (Inherited from RuntimeState)
	CurrentOffset	Gets the current offset.
	CurrentProfileId	Gets the current profile where Subassembly is being applied.
	CurrentRegionEndStation	Gets the current region's end station where a Subassembly is being applied.
	CurrentRegionStartStation	Gets the current region's start station where a Subassembly is being applied.
	CurrentStation	Gets the current baseline alignment station where a Subassembly is being applied.
	CurrentSubassemblyElevation	Returns the elevation difference from the assembly origin where the current subassembly is being applied.
	CurrentSubassemblyId	Gets the ObjectId of the current Subassembly being applied.
	CurrentSubassemblyName	Gets the name of the current Subassembly being applied.
	CurrentSubassemblyOffset	Returns the offset from assembly origin where the current subassembly is being applied.
	CurrentSubassemblyVersion	Sets the version of the current Subassembly being applied.
	LayoutModeDisplayType	Gets or sets the corridor state's display mode.
	Links	Gets the collection of links.
	Mode	Gets corridor state's mode.
	ParamsAlignment	Gets the collection of alignment parameters.
	ParamsAlignmentGlobal	ParamsAlignmentGlobal
	ParamsBool	Gets the collection of boolean parameters.
	ParamsBoolGlobal	ParamsBoolGlobal
	ParamsDouble	Gets the collection of double parameters.
	ParamsDoubleGlobal	ParamsDoubleGlobal
	ParamsElevationTarget	Gets the collection of elevation parameters.
	ParamsElevationTargetGlobal	ParamsElevationGlobal
	ParamsLong	Gets the collection of long parameters.
	ParamsLongGlobal	ParamsLongGlobal
	ParamsOffsetTarget	Gets the collection of offset target parameters.
	ParamsOffsetTargetGlobal	ParamsOffsetTargetGlobal
	ParamsPoint	Gets the collection of marked point parameters.
	ParamsPointGlobal	ParamsPointGlobal
	ParamsProfile	Gets the collection of profile parameters.
	ParamsProfileGlobal	ParamsProfileGlobal
	ParamsString	Gets the collection of string parameters.
	ParamsStringGlobal	ParamsStringGlobal
	ParamsSurface	Gets the collection of surface parameters.
	ParamsSurfaceGlobal	ParamsSurfaceGlobal
	Points	Gets the collection of points.
	ResourceStringString
	ResourceStringUInt32	Converts a resource id (numeric) to a resource string from the current subassembly's resource module.
	Shapes	Gets the collection of shapes.

Top

Methods

	Name	Description
	IntersectAlignment(ObjectId, ObjectId, IPoint, Boolean)	Intersects a ray with an alignment, with no maximum distance specified.
	IntersectAlignment(ObjectId, ObjectId, IPoint, Boolean, Double)	Intersects a ray with an alignment.
	IntersectLink	Intersects a ray with an assembly's links.
	IntersectSurface(ObjectId, ObjectId, IPoint, Boolean, Double)	Intersects a ray with a surface, with no maximum ray distance.
	IntersectSurface(ObjectId, ObjectId, IPoint, Boolean, Double, Double)	Intersects a ray with a surface.
	IntersectSurface(ObjectId, ObjectId, IPoint, Boolean, Double, Int32)	Intersects a ray with a surface, with no maximum ray distance and a maximum number of wanted intersection points.
	IsAboveSurface(ObjectId, ObjectId, IPoint)	Determines if roadway point is above a surface, with no minimum distance specified.
	IsAboveSurface(ObjectId, ObjectId, IPoint, Double)	Determines if roadway point is above a surface.
	RecordError	Record error.
	SampleSection	Samples elevation along an existing surface.
	SetAxisOfRotationCrownPoint	If the crown point is set, the axis of rotation uses it in its calculation for a divided crown/centers pivot type/multiple group assembly case. If a crown point is not set, the default Baseline pivot behavior is be used
	SetAxisOfRotationInformation	Save the AOR (Axis of Rotation) information for a subassembly
	SetAxisOfRotationSERange	By default, the axis of rotation calculation assumes the superelevation cross-slope set in SetAxisOfRotationInfomation applies to the full width of the subassembly. If the subassembly wants to override that behavior it can specify a starting and ending offset that indicates where superelavtion was applied.
	SoeToXyz	Transforms from assembly local station, offset, elevation (SOE) coordinates to world x,y,z coordinates.
	XyzToSoe	Transforms from world x,y,z coordinates to assembly local station, offset, elevation (SOE) coordinates.

Top

Reference

Autodesk.Civil.Runtime Namespace