|
NX Open C++ Reference Guide
|
A manager for load, creation and activation of visual reports. More...
A manager for load, creation and activation of visual reports.
<br> To obtain an instance of this class, refer to @link Session Session @endlink <br>
Created in NX7.0.0.
| void NXOpen::VisualReporting::VisualReportManager::ActivateCurrentVisualReport | ( | ) |
Activates the VisualReporting::VisualReportManager::Current visual report.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| NXOpen::VisualReporting::SpecifyDateBuilder* NXOpen::VisualReporting::VisualReportManager::CreateSpecifyDateBuilder | ( | ) |
Creates a VisualReporting::SpecifyDateBuilder .
@return The created builder
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| NXOpen::VisualReporting::VisualReportBuilder* NXOpen::VisualReporting::VisualReportManager::CreateVisualReportBuilder | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Creates a VisualReporting::VisualReportBuilder and starts editing a copy of the given VisualReport .
@return The created builder
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReport | The VisualReport for which this builder is being created. Can be NULL |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Current | ( | ) |
Returns the current VisualReporting::VisualReport .
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| void NXOpen::VisualReporting::VisualReportManager::DeactivateCurrentVisualReport | ( | ) |
Deactivates the VisualReporting::VisualReportManager::Current visual report.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::MergeReports | ( | const std::vector< NXOpen::VisualReporting::VisualReport * > & | visualReports, |
| const NXString & | mergedReportName, | ||
| const NXString & | mergedReportDescription | ||
| ) |
Merges multiple existing VisualReporting::VisualReport into one VisualReporting::VisualReport , but does not set them to be the VisualReporting::VisualReportManager::Current visual report or activate them, and does not save the merged VisualReporting::VisualReport .
@return merged report
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReports | array of existing reports |
| mergedReportName | name of the merged report NOTE: The full Unicode character set is not supported for this parameter. |
| mergedReportDescription | description of the merged report NOTE: The full Unicode character set is not supported for this parameter. |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::MergeReports | ( | const std::vector< NXOpen::VisualReporting::VisualReport * > & | visualReports, |
| const char * | mergedReportName, | ||
| const char * | mergedReportDescription | ||
| ) |
Merges multiple existing VisualReporting::VisualReport into one VisualReporting::VisualReport , but does not set them to be the VisualReporting::VisualReportManager::Current visual report or activate them, and does not save the merged VisualReporting::VisualReport .
@return merged report
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReports | array of existing reports |
| mergedReportName | name of the merged report NOTE: The full Unicode character set is not supported for this parameter. |
| mergedReportDescription | description of the merged report NOTE: The full Unicode character set is not supported for this parameter. |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Open | ( | const NXString & | filename | ) |
Opens an existing VisualReporting::VisualReport , but does not set it to be the VisualReporting::VisualReportManager::Current visual report or activate it.
If the visual report file cannot be opened, or if there is a problem parsing the file,
then an exception will be raised.
If opening a managed report then it is recommended to use @link VisualReporting::VisualReportManager::OpenReports VisualReporting::VisualReportManager::OpenReports@endlink
which can take a container path and list of dataset names
@return
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| filename | The filename of the visual report to open NOTE: The full Unicode character set is not supported for this parameter. |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Open | ( | const char * | filename | ) |
Opens an existing VisualReporting::VisualReport , but does not set it to be the VisualReporting::VisualReportManager::Current visual report or activate it.
If the visual report file cannot be opened, or if there is a problem parsing the file,
then an exception will be raised.
If opening a managed report then it is recommended to use @link VisualReporting::VisualReportManager::OpenReports VisualReporting::VisualReportManager::OpenReports@endlink
which can take a container path and list of dataset names
@return
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| filename | The filename of the visual report to open NOTE: The full Unicode character set is not supported for this parameter. |
| std::vector<NXOpen::VisualReporting::VisualReport *> NXOpen::VisualReporting::VisualReportManager::OpenReports | ( | std::vector< NXString > & | folders, |
| std::vector< NXString > & | names | ||
| ) |
Opens existing VisualReporting::VisualReport , but does not set them to be the VisualReporting::VisualReportManager::Current visual report or activate them.
If the visual report file cannot be opened, or if there is a problem parsing the file,
then an exception will be raised.
This can be used in native mode by sending in a folder path and filenames, or in
managed mode using a container path and dataset names.
@return array of opened reports
Created in NX7.5.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| folders | array of folders to be searched NOTE: The full Unicode character set is not supported for this parameter. |
| names | array of report names NOTE: The full Unicode character set is not supported for this parameter. |
| void NXOpen::VisualReporting::VisualReportManager::SetCurrent | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Sets the current VisualReporting::VisualReport .
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReport | visualreport |
| tag_t NXOpen::VisualReporting::VisualReportManager::Tag | ( | ) | const |
Returns the tag of this object.
| void NXOpen::VisualReporting::VisualReportManager::Unload | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Unloads an opened VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReport | visualreport |
| NXOpen::VisualReporting::VisualReportExplorer* NXOpen::VisualReporting::VisualReportManager::VisualReportExplorer | ( | ) |
Returns the VisualReporting::VisualReportExplorer belonging to this visual report manager
Created in NX7.5.0.
| NXOpen::VisualReporting::VisualReportCollection* NXOpen::VisualReporting::VisualReportManager::VisualReports | ( | ) |
Returns the VisualReporting::VisualReportCollection belonging to this visual report manager
Created in NX7.0.0.