NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Routing.Electrical.PathArrangementBuilder Class Reference

Builder class to manage Path Arrangements. More...

Inheritance diagram for NXOpen.Routing.Electrical.PathArrangementBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void ClearHarnessData ()
 Clears the builder data associated with stored harness, namely the ReferencePort and * the HarnessOccurrence, along with internal data. More...
 
unsafe void DeletePathArrangement ()
 Deletes path arrangement through builder More...
 
unsafe void EstablishPathArrangement ()
 Retrieves the Path Arrangement object based on the data stored in the builder. More...
 
unsafe void InitializeBuilderFromArrangedPort (NXOpen.Routing.Port port)
 Initializes builder from arranged port More...
 
unsafe void SetPathArrangementOrigin (NXOpen.Point3d point)
 Sets a new origin for the point on the harness path. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Assemblies.Component HarnessPartOccurrence [get, set]
 Returns or sets the harness component in the context of the part that was used to create the extracted port. More...
 
unsafe NXOpen.Routing.Port PrototypePort [get, set]
 Returns or sets the prototype of the extract port that is used as the reference port. More...
 
unsafe NXOpen.Assemblies.Component PrototypePortPartOccurrence [get, set]
 Returns or sets the component part that contains the prototype of the extract port that is used as the reference port. More...
 
unsafe NXOpen.TaggedObject ReferencePort [get, set]
 Returns or sets the port on which the offset is based when defining the path arrangement. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Builder class to manage Path Arrangements.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreatePathArrangementBuilder

Created in NX10.0.3

Member Function Documentation

unsafe void NXOpen.Routing.Electrical.PathArrangementBuilder.ClearHarnessData ( )
inline

Clears the builder data associated with stored harness, namely the ReferencePort and * the HarnessOccurrence, along with internal data.

Note that the PrototypePortPartOccurrence * and the PrototypePort are not cleared with this call.

Created in NX10.0.3

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.Electrical.PathArrangementBuilder.DeletePathArrangement ( )
inline

Deletes path arrangement through builder

Created in NX10.0.3

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.Electrical.PathArrangementBuilder.EstablishPathArrangement ( )
inline

Retrieves the Path Arrangement object based on the data stored in the builder.

If one does not yet exist, a new one will be created. The retrieved object is stored internally in the biuilder. This method is called after setting HarnessPartOccurrence and ReferencePort

Created in NX10.0.3

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.Electrical.PathArrangementBuilder.InitializeBuilderFromArrangedPort ( NXOpen.Routing.Port  port)
inline

Initializes builder from arranged port

Created in NX10.0.3

License requirements: routing_base ("Routing Basic")

Parameters
portRouting port whose associated path arrangement object is used to populate the data in the builder
unsafe void NXOpen.Routing.Electrical.PathArrangementBuilder.SetPathArrangementOrigin ( NXOpen.Point3d  point)
inline

Sets a new origin for the point on the harness path.

This point should be in the context of the current root part.

Created in NX10.0.3

License requirements: routing_base ("Routing Basic")

Parameters
pointOrigin of the path arrangement in the context of the root part.

Property Documentation

unsafe NXOpen.Assemblies.Component NXOpen.Routing.Electrical.PathArrangementBuilder.HarnessPartOccurrence
getset

Returns or sets the harness component in the context of the part that was used to create the extracted port.

Created in NX10.0.3

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Routing.Port NXOpen.Routing.Electrical.PathArrangementBuilder.PrototypePort
getset

Returns or sets the prototype of the extract port that is used as the reference port.

Created in NX10.0.3

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Assemblies.Component NXOpen.Routing.Electrical.PathArrangementBuilder.PrototypePortPartOccurrence
getset

Returns or sets the component part that contains the prototype of the extract port that is used as the reference port.

Created in NX10.0.3

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.TaggedObject NXOpen.Routing.Electrical.PathArrangementBuilder.ReferencePort
getset

Returns or sets the port on which the offset is based when defining the path arrangement.

The port property can be either a port or a port occurrence.

Created in NX10.0.3

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.