NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::Run Class Reference

Routing Run object references components and stocks which comprise a piping run. More...

Inheritance diagram for NXOpen::Routing::Run:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

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::CharacteristicListGetCharacteristics ()
 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::RoutingSystemGetRoutingSystem ()
 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.

Detailed Description

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.


Member Enumeration Documentation

Represents discrepancies in the run compared to another run.

Enumerator:
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.

Represents the status of a run.

Enumerator:
StatusValid 

Run is valid.

All items are connected and all segments have stocks assigned on them

StatusBroken 

Run is broken.

All items are not connected end to end

StatusIncomplete 

Run is incomplete.

Some segments do not have stock assigned on them


Member Function Documentation

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")

This will detect spools in a run.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
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

Returns:
Valid, broken or incomplete run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
Parameters:
runIdUnique identifier of the Run
NOTE: The full Unicode character set is not supported for this parameter.
runTypeType of the Run
NOTE: The full Unicode character set is not supported for this parameter.
fromArray of to items. Must be Port , Routing::Run or Routing::ControlPoint
toArray of to items. Must be Routing::Port , Routing::Run or Routing::ControlPoint
memberArray 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")

Parameters:
runIdUnique identifier of the Run
NOTE: The full Unicode character set is not supported for this parameter.
runTypeType of the Run
NOTE: The full Unicode character set is not supported for this parameter.
fromItemsArray of "From" item data.
toItemsArray of "To" item data.
memberItemsArray of "Member" item data.

Get all of the characteristics values on the this object.

Returns:

Created in NX7.5.4.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the data of the "From" items of a run.

Returns:
Array of data for the "From" items.
Created in NX7.5.4.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the from items of a run.

From items are extracted ports or run

Returns:
All from items of the run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the data of the "Member" items of a run.

Returns:
Array of data for the "Member" items.
Created in NX7.5.4.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the member items of a run.

Member items are extracted ports, stocks, or segments.

Returns:
All member items of the run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Ask the Routing::RoutingSystem run belongs to.

Returns:
RoutingSystem run belongs to
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Ask the compare status of run.

Returns:
Run compare status
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the run_id of run.

Returns:
Run id of run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Ask the status of run.

Returns:
Valid, broken or incomplete run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the run type of run.

Returns:
Run type of run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the data of the "To" items of a run.

Returns:
Array of data for the "To" items.
Created in NX7.5.4.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Retrieves the to items of a run.

To items are extracted ports or run

Returns:
All to items of the run
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Get flow direction of a run segment.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
Parameters:
segmentsegment

Reverse flow direction of a run segment
Created in NX5.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Parameters:
segmentsegment

Set flow direction of a run segment
Created in NX5.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")

Parameters:
segmentsegment
flowStateflow 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")

Parameters:
valuesvalues

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