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

Represents a collection TrueStudio objects
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Display::TrueStudioCollection:
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::Display::TrueStudioBuilderCreateTrueStudioBuilder (NXOpen::Display::TrueStudio *sObj)
 Creates a NXOpen::Display::TrueStudioBuilder object if TrueStudio is NULL. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Display::TrueStudioFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Display::TrueStudio with the given identifier as recorded in a journal. More...
 
NXOpen::Display::TrueStudioFindObject (const char *journalIdentifier)
 Finds the NXOpen::Display::TrueStudio 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 TrueStudio objects
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX6.0.0.


Member Function Documentation

iterator NXOpen::Display::TrueStudioCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Display::TrueStudioBuilder* NXOpen::Display::TrueStudioCollection::CreateTrueStudioBuilder ( NXOpen::Display::TrueStudio sObj)

Creates a NXOpen::Display::TrueStudioBuilder object if TrueStudio is NULL.

Otherwise, a TrueStudio object will be edited

Returns
return TrueStudio object builder
Created in NX6.0.0.

License requirements : None
Parameters
sObjIf TrueStudio object is not NULL, then this object will be edited
iterator NXOpen::Display::TrueStudioCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Display::TrueStudio* NXOpen::Display::TrueStudioCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Display::TrueStudio 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 found with the given journal identifier.

Returns
TrueStudio object found
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Display::TrueStudio* NXOpen::Display::TrueStudioCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Display::TrueStudio 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 found with the given journal identifier.

Returns
TrueStudio object found
Created in NX6.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
tag_t NXOpen::Display::TrueStudioCollection::Tag ( ) const

Returns the tag of this object.


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