NXOpen::VisualReporting::VisualReportCollection Class Reference

A collection of visual reports. More...

Inheritance diagram for NXOpen::VisualReporting::VisualReportCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.
iterator	end ()
	Returns an iterator addressing one past the last element.
NXOpen::VisualReporting::VisualReport *	FindObject (const NXString &journalIdentifier)
	Finds the VisualReport with the given identifier as recorded in a journal.
NXOpen::VisualReporting::VisualReport *	FindObject (const char *journalIdentifier)
	Finds the VisualReport with the given identifier as recorded in a journal.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

A collection of visual reports.

<br> To obtain an instance of this class, refer to @link VisualReporting::VisualReportManager  VisualReporting::VisualReportManager @endlink  <br> 

Created in NX7.0.0.

Member Function Documentation

iterator NXOpen::VisualReporting::VisualReportCollection::begin

(

)

Returns an iterator addressing the first element.

iterator NXOpen::VisualReporting::VisualReportCollection::end

(

)

Returns an iterator addressing one past the last element.

NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportCollection::FindObject

(

const NXString &

journalIdentifier

)

Finds the VisualReport 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.  @return  Visual report found, or null if no such visual report exists.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

journalIdentifier

Filename of the visual report to be found

NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportCollection::FindObject

(

const char *

journalIdentifier

)

Finds the VisualReport 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.  @return  Visual report found, or null if no such visual report exists.

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

journalIdentifier

Filename of the visual report to be found

tag_t NXOpen::VisualReporting::VisualReportCollection::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• VisualReporting_VisualReportCollection.hxx