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

A collection of collaborative designs. More...

Inheritance diagram for NXOpen::CollaborativeDesignCollection:
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::Assemblies::SubsetBuilderCurrentSubsetBuilder ()
 Returns the NXOpen::Assemblies::SubsetBuilder used to edit the current subset in the subset task environment
Created in NX8.5.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::CollaborativeDesignFindObject (const NXString &journalIdentifier)
 Finds the CollaborativeDesign with the given identifier as recorded in a journal. More...
 
NXOpen::CollaborativeDesignFindObject (const char *journalIdentifier)
 Finds the CollaborativeDesign with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

A collection of collaborative designs.


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

Created in NX8.5.0.

Member Function Documentation

iterator NXOpen::CollaborativeDesignCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Assemblies::SubsetBuilder* NXOpen::CollaborativeDesignCollection::CurrentSubsetBuilder ( )

Returns the NXOpen::Assemblies::SubsetBuilder used to edit the current subset in the subset task environment
Created in NX8.5.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

iterator NXOpen::CollaborativeDesignCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::TaggedObject* NXOpen::CollaborativeDesignCollection::Find ( const NXString journalIdentifier)

Finds the TaggedObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when Find is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Object found, or null if no such object exists
Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
journalIdentifierIdentifier of the TaggedObject to be found
NXOpen::TaggedObject* NXOpen::CollaborativeDesignCollection::Find ( const char *  journalIdentifier)

Finds the TaggedObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when Find is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Object found, or null if no such object exists
Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
journalIdentifierIdentifier of the TaggedObject to be found
NXOpen::CollaborativeDesign* NXOpen::CollaborativeDesignCollection::FindObject ( const NXString journalIdentifier)

Finds the CollaborativeDesign with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Collaborative design found, or null if no such collaborative design exists.
Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
journalIdentifierName of the collaborative design to be found
NXOpen::CollaborativeDesign* NXOpen::CollaborativeDesignCollection::FindObject ( const char *  journalIdentifier)

Finds the CollaborativeDesign with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Collaborative design found, or null if no such collaborative design exists.
Created in NX8.5.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
journalIdentifierName of the collaborative design to be found
tag_t NXOpen::CollaborativeDesignCollection::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.