NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Diagramming::PortCollection Class Reference

Represents a collection of Port. More...

Inheritance diagram for NXOpen::Diagramming::PortCollection:
NXOpen::TaggedObjectCollection

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...
 
NXOpen::Diagramming::PortBuilderCreatePortBuilder (NXOpen::Diagramming::Port *port)
 Creates a NXOpen::Diagramming::PortBuilder . More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Diagramming::PortFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Diagramming::Port with the given identifier as recorded in a journal. More...
 
NXOpen::Diagramming::PortFindObject (const char *journalIdentifier)
 Finds the NXOpen::Diagramming::Port with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of Port.


To obtain an instance of this class, refer to NXOpen::Diagramming::DiagrammingManager

Created in NX10.0.0.

Member Function Documentation

iterator NXOpen::Diagramming::PortCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Diagramming::PortBuilder* NXOpen::Diagramming::PortCollection::CreatePortBuilder ( NXOpen::Diagramming::Port port)

Creates a NXOpen::Diagramming::PortBuilder .

Returns

Created in NX10.0.0.

License requirements : None
Parameters
portNXOpen::Diagramming::Port to be edited, if NULL then create a new one
iterator NXOpen::Diagramming::PortCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Diagramming::Port* NXOpen::Diagramming::PortCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Diagramming::Port with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with given name.

Returns
NXOpen::Diagramming::Port with this name.
Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Diagramming::Port* NXOpen::Diagramming::PortCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Diagramming::Port with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with given name.

Returns
NXOpen::Diagramming::Port with this name.
Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
tag_t NXOpen::Diagramming::PortCollection::Tag ( ) const

Returns the tag of this object.


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