Builder class to manage Path Arrangements. More...
Public Member Functions | |
| void | ClearHarnessData () |
| Clears the builder data associated with stored harness, namely the ReferencePort and the HarnessOccurrence, along with internal data. More... | |
| void | DeletePathArrangement () |
| Deletes path arrangement through builder Created in NX10.0.3. More... | |
| void | EstablishPathArrangement () |
| Retrieves the Path Arrangement object based on the data stored in the builder. More... | |
| NXOpen::Assemblies::Component * | HarnessPartOccurrence () |
| Returns the harness component in the context of the part that was used to create the extracted port. More... | |
| void | InitializeBuilderFromArrangedPort (NXOpen::Routing::Port *port) |
| Initializes builder from arranged port Created in NX10.0.3. More... | |
| NXOpen::Routing::Port * | PrototypePort () |
| Returns the prototype of the extract port that is used as the reference port. More... | |
| NXOpen::Assemblies::Component * | PrototypePortPartOccurrence () |
| Returns the component part that contains the prototype of the extract port that is used as the reference port. More... | |
| NXOpen::TaggedObject * | ReferencePort () |
| Returns the port on which the offset is based when defining the path arrangement. More... | |
| void | SetHarnessPartOccurrence (NXOpen::Assemblies::Component *partOcc) |
| Sets the harness component in the context of the part that was used to create the extracted port. More... | |
| void | SetPathArrangementOrigin (const NXOpen::Point3d &point) |
| Sets a new origin for the point on the harness path. More... | |
| void | SetPrototypePort (NXOpen::Routing::Port *port) |
| Sets the prototype of the extract port that is used as the reference port. More... | |
| void | SetPrototypePortPartOccurrence (NXOpen::Assemblies::Component *partOcc) |
| Sets the component part that contains the prototype of the extract port that is used as the reference port. More... | |
| void | SetReferencePort (NXOpen::TaggedObject *port) |
| Sets the port on which the offset is based when defining the path arrangement. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. 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
| void NXOpen::Routing::Electrical::PathArrangementBuilder::ClearHarnessData | ( | ) |
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")
| void NXOpen::Routing::Electrical::PathArrangementBuilder::DeletePathArrangement | ( | ) |
Deletes path arrangement through builder
Created in NX10.0.3.
License requirements : routing_base ("Routing Basic")
| void NXOpen::Routing::Electrical::PathArrangementBuilder::EstablishPathArrangement | ( | ) |
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")
| NXOpen::Assemblies::Component* NXOpen::Routing::Electrical::PathArrangementBuilder::HarnessPartOccurrence | ( | ) |
Returns the harness component in the context of the part that was used to create the extracted port.
Created in NX10.0.3.
License requirements : routing_base ("Routing Basic")
| void NXOpen::Routing::Electrical::PathArrangementBuilder::InitializeBuilderFromArrangedPort | ( | NXOpen::Routing::Port * | port | ) |
Initializes builder from arranged port
Created in NX10.0.3.
License requirements : routing_base ("Routing Basic")
- Parameters
-
port Routing port whose associated path arrangement object is used to populate the data in the builder
| NXOpen::Routing::Port* NXOpen::Routing::Electrical::PathArrangementBuilder::PrototypePort | ( | ) |
Returns the prototype of the extract port that is used as the reference port.
Created in NX10.0.3.
License requirements : routing_base ("Routing Basic")
| NXOpen::Assemblies::Component* NXOpen::Routing::Electrical::PathArrangementBuilder::PrototypePortPartOccurrence | ( | ) |
Returns 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 : routing_base ("Routing Basic")
| NXOpen::TaggedObject* NXOpen::Routing::Electrical::PathArrangementBuilder::ReferencePort | ( | ) |
Returns 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 : routing_base ("Routing Basic")
| void NXOpen::Routing::Electrical::PathArrangementBuilder::SetHarnessPartOccurrence | ( | NXOpen::Assemblies::Component * | partOcc | ) |
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 : routing_base ("Routing Basic")
- Parameters
-
partOcc partocc
| void NXOpen::Routing::Electrical::PathArrangementBuilder::SetPathArrangementOrigin | ( | const NXOpen::Point3d & | point | ) |
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
-
point Origin of the path arrangement in the context of the root part.
| void NXOpen::Routing::Electrical::PathArrangementBuilder::SetPrototypePort | ( | NXOpen::Routing::Port * | port | ) |
Sets the prototype of the extract port that is used as the reference port.
Created in NX10.0.3.
License requirements : routing_base ("Routing Basic")
- Parameters
-
port port
| void NXOpen::Routing::Electrical::PathArrangementBuilder::SetPrototypePortPartOccurrence | ( | NXOpen::Assemblies::Component * | partOcc | ) |
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 : routing_base ("Routing Basic")
- Parameters
-
partOcc partocc
| void NXOpen::Routing::Electrical::PathArrangementBuilder::SetReferencePort | ( | NXOpen::TaggedObject * | port | ) |
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 : routing_base ("Routing Basic")
- Parameters
-
port port
The documentation for this class was generated from the following file:
- Routing_Electrical_PathArrangementBuilder.hxx