XSPolygon Class

Note: This API is now obsolete.

Inheritance Hierarchy

SystemObject
  DHI.Mike1D.CrossSectionModuleXSBase
    DHI.Mike1D.CrossSectionModuleXSBaseRaw
      DHI.Mike1D.CrossSectionModuleXSPolygon

Namespace: DHI.Mike1D.CrossSectionModule
Assembly: DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 18.0.0.0 (11.1.1.1111)

Syntax

Copy

[ObsoleteAttribute("Use XSBaseRaw, it handles now both XSOpen and XSPolygon")]
public class XSPolygon : XSBaseRaw

The XSPolygon type exposes the following members.

Constructors

	Name	Description
	XSPolygon	Initializes a new instance of the XSPolygon class
	XSPolygon(XSBaseRaw)	Initializes a new instance of the XSPolygon class

Top

Properties

	Name	Description
	Angle	(Inherited from XSBaseRaw.)
	ApplyAngle	(Inherited from XSBaseRaw.)
	AutoProcess	(Inherited from XSBase.)
	BottomLevel	(Inherited from XSBase.)
	CrossSectionType	(Inherited from XSBase.)
	EquidistantLevels	(Inherited from XSBase.)
	FlowDir	(Inherited from XSBaseRaw.)
	FlowResistance	(Inherited from XSBase.)
	HasProcessedData	(Inherited from XSBase.)
	Height	(Inherited from XSBase.)
	Interpolated	(Inherited from XSBaseRaw.)
	IsOpen	(Inherited from XSBaseRaw.)
	LeftCoordinateMarker	(Inherited from XSBaseRaw.)
	LeftLeveeBank	(Inherited from XSBaseRaw.)
	LeftLowFlowBank	(Inherited from XSBaseRaw.)
	LowestPoint	(Inherited from XSBaseRaw.)
	MaximumStorageWidth	(Inherited from XSBaseRaw.)
	ModifiedFormulation	(Inherited from XSBase.)
	ModifiedResistanceFactors	(Inherited from XSBase.)
	MorphologicalDivision	(Inherited from XSBase.)
	MorphologicalDivisionType	(Inherited from XSBase.)
	NumberOfProcessedLevels	(Inherited from XSBase.)
	Points	(Inherited from XSBaseRaw.)
	ProcessedAdditionalSurfaceAreas	(Inherited from XSBase.)
	ProcessedAreas	(Inherited from XSBase.)
	ProcessedDataProtected	(Inherited from XSBase.)
	ProcessedDataStatus	(Inherited from XSBase.)
	ProcessedDerivatives	(Inherited from XSBase.)
	ProcessedFlowAreas	(Inherited from XSBase.)
	ProcessedLevels	(Inherited from XSBase.)
	ProcessedRadii	(Inherited from XSBase.)
	ProcessedRadiiDerivatives	(Inherited from XSBase.)
	ProcessedResistanceFactors	(Inherited from XSBase.)
	ProcessedStorageWidths	(Inherited from XSBase.)
	ProcessingLevelsSpecs	(Inherited from XSBase.)
	RadiusType	(Inherited from XSBaseRaw.)
	RelativeConveyanceCutoff	(Inherited from XSBase.)
	RightCoordinateMarker	(Inherited from XSBaseRaw.)
	RightLeveeBank	(Inherited from XSBaseRaw.)
	RightLowFlowBank	(Inherited from XSBaseRaw.)
	Selected	(Inherited from XSBaseRaw.)
	Symmetric	(Inherited from XSBaseRaw.)
	TopLevel	(Inherited from XSBase.)
	TopoID	(Inherited from XSBase.)

Top

Methods

	Name	Description
	AdjustProcessedLevels(Double)	(Inherited from XSBase.)
	AdjustProcessedLevelSpecs	(Inherited from XSBase.)
	BottomLevelFromCenter	(Inherited from XSBaseRaw.)
	CalculateProcessedData	(Inherited from XSBaseRaw.)
	CalculateProcessedDataIfNeeded	(Inherited from XSBase.)
	CheckProcessedData	(Inherited from XSBase.)
	ClearOriginalProcessedData	(Inherited from XSBase.)
	ClearZones	(Inherited from XSBaseRaw.)
	Clone	(Overrides XSBaseRawClone.)
	ConvertModifiedResistanceFactorsIfNecessary	(Inherited from XSBase.)
	ConvertRelativeResistanceMultiZones	(Inherited from XSBase.)
	CopyValuesToOther	(Inherited from XSBaseRaw.)
	CreateAllProcessedArrays	(Inherited from XSBase.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetActualMorphologicalDivision	(Inherited from XSBase.)
	GetAdditionalSurfaceArea	(Inherited from XSBase.)
	GetArea	(Inherited from XSBase.)
	GetAreaByIntegratingWidths	(Inherited from XSBase.)
	GetCriticalDepth	(Inherited from XSBase.)
	GetCriticalDischarge	(Inherited from XSBase.)
	GetFlowArea(Int32)	(Inherited from XSBase.)
	GetFlowArea(Int32, Double)	(Inherited from XSBase.)
	GetFlowAreaDerivative	(Inherited from XSBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHydraulicRadius(Int32)	(Inherited from XSBase.)
	GetHydraulicRadius(Int32, Double)	(Inherited from XSBase.)
	GetHydraulicRadiusDerivative	(Inherited from XSBase.)
	GetLevelFromArea	(Inherited from XSBase.)
	GetLocalVelocity	(Inherited from XSBaseRaw.)
	GetLocalVelocityFactor	(Inherited from XSBaseRaw.)
	GetLocalVelocityFactorFromIntegral	(Inherited from XSBaseRaw.)
	GetMarkerIndex	(Inherited from XSBaseRaw.)
	GetMarkerSequence	(Inherited from XSBaseRaw.)
	GetMarkersOfPoint	(Inherited from XSBaseRaw.)
	GetMaximumValues	(Inherited from XSBase.)
	GetNaturalDepthOld	Obsolete. (Inherited from XSBase.)
	GetResistanceFactor	(Inherited from XSBase.)
	GetResistanceFactorsDerivative	(Inherited from XSBase.)
	GetStorageWidth(Int32)	(Inherited from XSBase.)
	GetStorageWidth(Int32, Double)	(Inherited from XSBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVolumeFromAdditionalSurfaceArea	(Inherited from XSBase.)
	InheritProcessedDataFrom	(Inherited from XSBase.)
	Initialize	(Inherited from XSBaseRaw.)
	Level	(Inherited from XSBase.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	(Inherited from XSBase.)
	ProcessedLevel	(Inherited from XSBase.)
	RestoreModifiedResistanceFactors	(Inherited from XSBase.)
	RestoreOriginalProcessedData	(Inherited from XSBase.)
	SaveOriginalProcessedData	(Inherited from XSBase.)
	SetAllProcessedValues	(Inherited from XSBase.)
	SetMarkerAt	(Inherited from XSBaseRaw.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateMarkersToDefaults	(Inherited from XSBaseRaw.)
	UpdatePointMarkerString	(Inherited from XSBaseRaw.)
	UpdatePointResistance	(Inherited from XSBaseRaw.)
	Validate	(Inherited from XSBaseRaw.)

Top

Fields

	Name	Description
	_bAutoProcess	(Inherited from XSBase.)
	_bProcessedDataProtected	(Inherited from XSBase.)
	_crossSectionType	(Inherited from XSBase.)
	_distanceBetweenLevels	(Inherited from XSBase.)
	_equidistantLevels	(Inherited from XSBase.)
	_flowResistance	(Inherited from XSBase.)
	_height	(Inherited from XSBase.)
	_isInitialized	(Inherited from XSBase.)
	_isPrepared	(Inherited from XSBase.)
	_modifiedFormulation	(Inherited from XSBase.)
	_modifiedResistanceFactors	(Inherited from XSBase.)
	_modifiedResistanceFactorsDerivatives	(Inherited from XSBase.)
	_numberOfProcessedLevels	(Inherited from XSBase.)
	_originalProcessedData	(Inherited from XSBase.)
	_processedAdditionalSurfaceAreas	(Inherited from XSBase.)
	_processedAreas	(Inherited from XSBase.)
	_processedCriticalDischarges	(Inherited from XSBase.)
	_processedDataStatus	(Inherited from XSBase.)
	_processedDerivatives	(Inherited from XSBase.)
	_processedFlowAreas	(Inherited from XSBase.)
	_processedLevels	(Inherited from XSBase.)
	_processedRadii	(Inherited from XSBase.)
	_processedRadiiDerivatives	(Inherited from XSBase.)
	_processedResistanceFactors	(Inherited from XSBase.)
	_processedStorageWidths	(Inherited from XSBase.)
	_resistenceDistri	(Inherited from XSBase.)

Top

Extension Methods

	Name	Description
	GetConveyance	(Defined by CrossSectionExtensions.)

Top

Reference

DHI.Mike1D.CrossSectionModule Namespace