AddTube Method

Description

Creates a new Occurrence object in the Assembly document. This occurrence behaves like any other occurrence in the Assembly file, except it successfully returns a Tube object when the Tube property is invoked on the Occurrence.

Syntax

Visual Basic
Public Function AddTube( _ ByRef TubeSegments() As Object, _ ByRef PartFileName As String, _ Optional ByVal TemplateFileName As Variant, _ Optional ByVal IsSolid As Variant, _ Optional ByVal Material As Variant, _ Optional ByVal BendRadius As Variant, _ Optional ByVal OuterDiameter As Variant, _ Optional ByVal MinimumFlatLength As Variant, _ Optional ByVal WallThickness As Variant, _ Optional ByVal ExtendStart As Variant, _ Optional ByVal ExtendEnd As Variant, _ Optional ByVal AddConnectRelations As Variant, _ Optional ByVal StartEndTreatmentType As Variant, _ Optional ByVal StartEndTreatmentInsideDiameter As Variant, _ Optional ByVal StartEndTreatmentOutsideDiameter As Variant, _ Optional ByVal StartEndTreatmentRadius As Variant, _ Optional ByVal StartEndTreatmentDepth As Variant, _ Optional ByVal StartEndTreatmentAngle As Variant, _ Optional ByVal EndEndTreatmentType As Variant, _ Optional ByVal EndEndTreatmentInsideDiameter As Variant, _ Optional ByVal EndEndTreatmentOutsideDiameter As Variant, _ Optional ByVal EndEndTreatmentRadius As Variant, _ Optional ByVal EndEndTreatmentDepth As Variant, _ Optional ByVal EndEndTreatmentAngle As Variant _ ) As Occurrence

Visual Basic

Public Function AddTube( _
   ByRef TubeSegments() As Object, _
   ByRef PartFileName As String, _
   Optional ByVal TemplateFileName As Variant, _
   Optional ByVal IsSolid As Variant, _
   Optional ByVal Material As Variant, _
   Optional ByVal BendRadius As Variant, _
   Optional ByVal OuterDiameter As Variant, _
   Optional ByVal MinimumFlatLength As Variant, _
   Optional ByVal WallThickness As Variant, _
   Optional ByVal ExtendStart As Variant, _
   Optional ByVal ExtendEnd As Variant, _
   Optional ByVal AddConnectRelations As Variant, _
   Optional ByVal StartEndTreatmentType As Variant, _
   Optional ByVal StartEndTreatmentInsideDiameter As Variant, _
   Optional ByVal StartEndTreatmentOutsideDiameter As Variant, _
   Optional ByVal StartEndTreatmentRadius As Variant, _
   Optional ByVal StartEndTreatmentDepth As Variant, _
   Optional ByVal StartEndTreatmentAngle As Variant, _
   Optional ByVal EndEndTreatmentType As Variant, _
   Optional ByVal EndEndTreatmentInsideDiameter As Variant, _
   Optional ByVal EndEndTreatmentOutsideDiameter As Variant, _
   Optional ByVal EndEndTreatmentRadius As Variant, _
   Optional ByVal EndEndTreatmentDepth As Variant, _
   Optional ByVal EndEndTreatmentAngle As Variant _
) As Occurrence

Parameters

TubeSegments: Specifies the objects that will define the tube path. This array can include LineSegment and Layout objects. The order of the elements in the array is significant only to the degree that the elements must form an end-to-end sequence. That is, only the first and last elements will have a free end.
PartFileName: Specifies the fully qualified path name of the output Part file that will contain the Tube.
TemplateFileName: Specifies the name of a Part file to be used as a template when creating the Part file. If not specified, normal.par is used as the template.
IsSolid: Specifies whether the created tube is solid (True) or hollow (False). If not specified, a hollow tube is created.
Material: Specifies a material condition to be applied to the tube.
BendRadius: Specifies the bend radius to be applied to the tube. If not specified, the global setting is used. The tube is recomputed as needed if the global setting changes.
OuterDiameter: Specifies the outer diameter to be applied to the tube. If not specified, the global setting is used. The tube is recomputed as needed if the global setting changes.
MinimumFlatLength: Specifies the minimum flat length to be applied to the tube. If not specified, the global setting is used. The tube is recomputed as needed if the global setting changes.
WallThickness: Specifies the wall thickness to be applied to the tube. If not specified, the global setting is used. The tube is recomputed as needed if the global setting changes.
ExtendStart: Specifies the extension (if a positive value) or setback (if a negative value) of the Tube with respect to the start point of the tube. If not specified, 0.0 is used
ExtendEnd: Specifies the extension (if a positive value) or setback (if a negative value) of the Tube with respect to the end point of the tube. If not specified, 0.0 is used.
AddConnectRelations: Specifies whether or not connect relationships are placed at all of the points where any two segments meet. If connect relationships are already present, AddConnectRelations should be False.
StartEndTreatmentType: Defines the type of end treatment for the start of the tube. The start of the tube is dictated by the direction of the first segment passed into the TubeSegments array. Valid values are members of the TubeEndTreatmentTypeConstants constant set.
StartEndTreatmentInsideDiameter: Specifies the inside diameter of the end treatment at the start of the tube. If not specified, the global default end treatment inside diameter is used.
StartEndTreatmentOutsideDiameter: Specifies the outside diameter of the end treatment at the start of the tube. If not specified, the global default end treatment outside diameter is used.
StartEndTreatmentRadius: Specifies the radius of the end treatment at the start of the tube. If not specified, the global default end treatment radius is used.
StartEndTreatmentDepth: Specifies the depth of the end treatment at the start of the tube. If not specified, the global default end treatment depth is used.
StartEndTreatmentAngle: Specifies the angle of the end treatment at the start of the tube. If not specified, the global default end treatment angle is used.
EndEndTreatmentType: Defines the type of end treatment for the end of the tube. The end of the tube is dictated by the direction of the first segment passed into the TubeSegments array. Valid values are members of the TubeEndTreatmentTypeConstants constant set.
EndEndTreatmentInsideDiameter: Specifies the inside diameter of the end treatment at the end of the tube. If not specified, the global default end treatment inside diameter is used.
EndEndTreatmentOutsideDiameter: Specifies the outside diameter of the end treatment at the end of the tube. If not specified, the global default end treatment outside diameter is used.
EndEndTreatmentRadius: Specifies the radius of the end treatment at the end of the tube. If not specified, the global default end treatment radius is used.
EndEndTreatmentDepth: Specifies the depth of the end treatment at the end of the tube. If not specified, the global default end treatment depth is used.
EndEndTreatmentAngle: Specifies the angle of the end treatment at the end of the tube. If not specified, the global default end treatment angle is used.

Remarks

The Tube object encapsulates all the information about the Tube, including the Tube path, material, bend radii, outer diameter, wall thickness, and so forth. Because the array of tube segments may not be in strict sequence, the AddTube method does not include the bend radius override parameters.