Create Method (ObjectIdCollection, ObjectId, ObjectId, Double, ObjectId)

Creates a new instance of a SpanningPipeProfileLabel that spans a collection of ProfileViewParts using the specified label style.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.2.3892.0

Syntax

C#

public static ObjectId Create(
	ObjectIdCollection profileViewPartIds,
	ObjectId anchorProfileViewPartId,
	ObjectId profileViewId,
	double ratio,
	ObjectId labelStyleId
)

Visual Basic

Public Shared Function Create ( _
	profileViewPartIds As ObjectIdCollection, _
	anchorProfileViewPartId As ObjectId, _
	profileViewId As ObjectId, _
	ratio As Double, _
	labelStyleId As ObjectId _
) As ObjectId

Visual C++

public:
static ObjectId Create(
	ObjectIdCollection^ profileViewPartIds, 
	ObjectId anchorProfileViewPartId, 
	ObjectId profileViewId, 
	double ratio, 
	ObjectId labelStyleId
)

Parameters

profileViewPartIds
Type: ObjectIdCollection
An ObjectIdCollection of ProfileViewParts that need spanning.
anchorProfileViewPartId
Type: ObjectId
The ObjectId of a ProfileViewPart on which the label is located.
profileViewId
Type: ObjectId
The ObjectId of the ProfileView in which the label is located.
ratio
Type: System.Double
A ratio that determines the relative position of the label to the ProfileViewPart.
labelStyleId
Type: ObjectId
The ObjectId of SpanningPipeLabel style.

Remarks

  • The ratio should be in the range [0, 1].
  • The source of anchorProfileViewPartId should be a pipe.
  • A path crossing each item in profileViewPartIds is calculated, and each profileViewPart on the path is spanned.
  • If the path crossing two adjacent items in partIds crosses back to the start part to form a loop, the spanned part in the loop is abandoned.

Exceptions

ExceptionCondition
System.ArgumentException Thrown when:
  • The anchorProfileViewPartId, profileViewId or labelStyleId is invalid.
  • The items in profileViewPartIds are not in the same PipeNetwork.
  • The items in profileViewPartIds are not in the ProfileView.
  • A path crossing two adjacent items in the profileViewPartIds can not be found.
  • The ratio is out of range.

See Also