Represents a collection of NXOpen::Routing::Port objects. More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
| iterator | begin () |
| Returns an iterator addressing the first element. More... | |
| void | ConvertToFeatures () |
| Cycles through all the NXOpen::Routing::Port objects and creates a NXOpen::Routing::FeaturePort object for NXOpen::Routing::FittingPort object, NXOpen::Routing::FixturePort object, NXOpen::Routing::MultiPort object, and NXOpen::Routing::TerminalPort object. More... | |
| NXOpen::Routing::ExtractPort * | CreateExtractPort (NXOpen::Routing::Port *port) |
| Creates a NXOpen::Routing::ExtractPort . More... | |
| NXOpen::Routing::ExtractPort * | CreateExtractPort (NXOpen::Routing::Port *port, bool allowMultipleConnections) |
| Creates a NXOpen::Routing::ExtractPort . More... | |
| iterator | end () |
| Returns an iterator addressing one past the last element. More... | |
| std::vector < NXOpen::Routing::Port * > | GetComponentPorts (NXOpen::Assemblies::Component *component) |
| Given a component, returns the port occurrences that belong to it. More... | |
| std::vector < NXOpen::Routing::Port * > | GetObjectPorts (NXOpen::NXObject *entity) |
| Given any NXObject , returns any port occurrences that belong to it. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents a collection of NXOpen::Routing::Port objects.
Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that NXOpen::Routing::Port is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed.
To obtain an instance of this class, refer to NXOpen::Routing::RouteManager
Created in NX4.0.0.
Member Function Documentation
| iterator NXOpen::Routing::PortCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| void NXOpen::Routing::PortCollection::ConvertToFeatures | ( | ) |
Cycles through all the NXOpen::Routing::Port objects and creates a NXOpen::Routing::FeaturePort object for NXOpen::Routing::FittingPort object, NXOpen::Routing::FixturePort object, NXOpen::Routing::MultiPort object, and NXOpen::Routing::TerminalPort object.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
| NXOpen::Routing::ExtractPort* NXOpen::Routing::PortCollection::CreateExtractPort | ( | NXOpen::Routing::Port * | port | ) |
Creates a NXOpen::Routing::ExtractPort .
Default allows multiple connections to this port.
- Returns
- Extracted Port
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
- Parameters
-
port Port to extract from
| NXOpen::Routing::ExtractPort* NXOpen::Routing::PortCollection::CreateExtractPort | ( | NXOpen::Routing::Port * | port, |
| bool | allowMultipleConnections | ||
| ) |
Creates a NXOpen::Routing::ExtractPort .
- Returns
- Extracted Port
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
- Parameters
-
port Port to extract from allowMultipleConnections Does this fitting port allow multiple wires to be routed to it?
| iterator NXOpen::Routing::PortCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| std::vector<NXOpen::Routing::Port *> NXOpen::Routing::PortCollection::GetComponentPorts | ( | NXOpen::Assemblies::Component * | component | ) |
Given a component, returns the port occurrences that belong to it.
Returns NULL otherwise.
- Returns
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
- Parameters
-
component component
| std::vector<NXOpen::Routing::Port *> NXOpen::Routing::PortCollection::GetObjectPorts | ( | NXOpen::NXObject * | entity | ) |
Given any NXObject , returns any port occurrences that belong to it.
Returns NULL otherwise.
The type of ports returned depends on the type of object given.
If given a NXOpen::Routing::ISegment , if there is stock on the segment, returns the ports from stock. If there is no stock, returns any fitting ports at the segment ends.
If given a NXOpen::Routing::Stock , returns the ports at ends of stock.
If given a NXOpen::Routing::Port , returns itself.
if given a NXOpen::Routing::ControlPoint , returns any fitting ports at the Control Point.
If given a part, returns any ports in the part.
- Returns
Created in NX11.0.1.
License requirements : routing_base ("Routing Basic")
- Parameters
-
entity entity
| tag_t NXOpen::Routing::PortCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Routing_PortCollection.hxx