NX Open C++ Reference Guide
|
Routing Run object references components and stocks which comprise a piping run. More...
Public Types | |
enum | CompareStatus { CompareStatusNone, CompareStatusOk, CompareStatusMissingRun, CompareStatusExtraRun, CompareStatusMissingItem, CompareStatusExtraItem, CompareStatusDiscrepancy } |
Represents discrepancies in the run compared to another run. More... | |
enum | Status { StatusValid, StatusBroken, StatusIncomplete } |
Represents the status of a run. More... | |
Public Member Functions | |
void | DeleteRunPath () |
This will delete the Run path and member items in a run Created in NX8.0.0. | |
std::vector< NXOpen::ObjectList * > | DetectRunSpools () |
This will detect spools in a run. | |
NXOpen::Routing::Run::Status | Edit (const NXString &runId, const NXString &runType, const std::vector< NXOpen::NXObject * > &from, const std::vector< NXOpen::NXObject * > &to, const std::vector< NXOpen::NXObject * > &member) |
Edits an existing run with new items. | |
void | Edit (const NXString &runId, const NXString &runType, const std::vector< NXOpen::Routing::RunItem * > &fromItems, const std::vector< NXOpen::Routing::RunItem * > &toItems, const std::vector< NXOpen::Routing::RunItem * > &memberItems) |
Edits an existing run with new run item data. | |
NXOpen::Routing::CharacteristicList * | GetCharacteristics () |
Get all of the characteristics values on the this object. | |
std::vector < NXOpen::Routing::RunItem * > | GetFromItemData () |
Retrieves the data of the "From" items of a run. | |
std::vector< NXOpen::NXObject * > | GetFromItems () |
Retrieves the from items of a run. | |
std::vector < NXOpen::Routing::RunItem * > | GetMemberItemData () |
Retrieves the data of the "Member" items of a run. | |
std::vector< NXOpen::NXObject * > | GetMemberItems () |
Retrieves the member items of a run. | |
NXOpen::Routing::RoutingSystem * | GetRoutingSystem () |
Ask the Routing::RoutingSystem run belongs to. | |
NXOpen::Routing::Run::CompareStatus | GetRunCompareStatus () |
Ask the compare status of run. | |
NXString | GetRunId () |
Retrieves the run_id of run. | |
NXOpen::Routing::Run::Status | GetRunStatus () |
Ask the status of run. | |
NXString | GetRunType () |
Retrieves the run type of run. | |
std::vector < NXOpen::Routing::RunItem * > | GetToItemData () |
Retrieves the data of the "To" items of a run. | |
std::vector< NXOpen::NXObject * > | GetToItems () |
Retrieves the to items of a run. | |
int | RunSegmentGetFlowDirection (NXOpen::Routing::ISegment *segment) |
Get flow direction of a run segment. | |
void | RunSegmentReverseFlowDirection (NXOpen::Routing::ISegment *segment) |
Reverse flow direction of a run segment Created in NX5.0.0. | |
void | RunSegmentSetFlowDirection (NXOpen::Routing::ISegment *segment, int flowState) |
Set flow direction of a run segment Created in NX5.0.0. | |
void | SetCharacteristics (NXOpen::Routing::CharacteristicList *values) |
Set all of the characteristics values on this object. |
Routing Run object references components and stocks which comprise a piping run.
To create an instance of this class us Routing::RunCollection::CreateRun
Created in NX4.0.0.
Represents discrepancies in the run compared to another run.
CompareStatusNone |
Run has no compare status. Compare operation is not invoked yet |
CompareStatusOk |
No missing, extra or discrepancy items. |
CompareStatusMissingRun |
Entire run is missing. |
CompareStatusExtraRun |
Entire run is extra. |
CompareStatusMissingItem |
Item or items are missing from the run. |
CompareStatusExtraItem |
Extra item or items present in the run. |
CompareStatusDiscrepancy |
Items have characteristics discrepancies. |
void NXOpen::Routing::Run::DeleteRunPath | ( | ) |
This will delete the Run path and member items in a run
Created in NX8.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
std::vector<NXOpen::ObjectList *> NXOpen::Routing::Run::DetectRunSpools | ( | ) |
This will detect spools in a run.
NXOpen::Routing::Run::Status NXOpen::Routing::Run::Edit | ( | const NXString & | runId, |
const NXString & | runType, | ||
const std::vector< NXOpen::NXObject * > & | from, | ||
const std::vector< NXOpen::NXObject * > & | to, | ||
const std::vector< NXOpen::NXObject * > & | member | ||
) |
Edits an existing run with new items.
NOTE: Removes any existing items in the run and adds these new items
runId | Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter. |
runType | Type of the Run NOTE: The full Unicode character set is not supported for this parameter. |
from | Array of to items. Must be Port , Routing::Run or Routing::ControlPoint |
to | Array of to items. Must be Routing::Port , Routing::Run or Routing::ControlPoint |
member | Array of member items. Must be Assemblies::Component , Routing::ISegment or Routing.Stock |
void NXOpen::Routing::Run::Edit | ( | const NXString & | runId, |
const NXString & | runType, | ||
const std::vector< NXOpen::Routing::RunItem * > & | fromItems, | ||
const std::vector< NXOpen::Routing::RunItem * > & | toItems, | ||
const std::vector< NXOpen::Routing::RunItem * > & | memberItems | ||
) |
Edits an existing run with new run item data.
NOTE: Removes any existing items in the run and adds these new items.
Created in NX7.5.4.
License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
runId | Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter. |
runType | Type of the Run NOTE: The full Unicode character set is not supported for this parameter. |
fromItems | Array of "From" item data. |
toItems | Array of "To" item data. |
memberItems | Array of "Member" item data. |
Get all of the characteristics values on the this object.
std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetFromItemData | ( | ) |
Retrieves the data of the "From" items of a run.
std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetFromItems | ( | ) |
Retrieves the from items of a run.
From items are extracted ports or run
std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetMemberItemData | ( | ) |
Retrieves the data of the "Member" items of a run.
std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetMemberItems | ( | ) |
Retrieves the member items of a run.
Member items are extracted ports, stocks, or segments.
Ask the Routing::RoutingSystem run belongs to.
Ask the compare status of run.
Retrieves the run_id of run.
Ask the status of run.
Retrieves the run type of run.
std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetToItemData | ( | ) |
Retrieves the data of the "To" items of a run.
std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetToItems | ( | ) |
Retrieves the to items of a run.
To items are extracted ports or run
Get flow direction of a run segment.
segment | segment |
Reverse flow direction of a run segment
Created in NX5.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
segment | segment |
void NXOpen::Routing::Run::RunSegmentSetFlowDirection | ( | NXOpen::Routing::ISegment * | segment, |
int | flowState | ||
) |
Set flow direction of a run segment
Created in NX5.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
segment | segment |
flowState | flow state |
Set all of the characteristics values on this object.
Created in NX7.5.4.
License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
values | values |