NX Open C++ Reference Guide
Public Member Functions
NXOpen::VisualReporting::VisualReportManager Class Reference

A manager for load, creation and activation of visual reports. More...

List of all members.

Public Member Functions

void ActivateCurrentVisualReport ()
 Activates the VisualReporting::VisualReportManager::Current visual report.
NXOpen::VisualReporting::SpecifyDateBuilderCreateSpecifyDateBuilder ()
 Creates a VisualReporting::SpecifyDateBuilder .
NXOpen::VisualReporting::VisualReportBuilderCreateVisualReportBuilder (NXOpen::VisualReporting::VisualReport *visualReport)
 Creates a VisualReporting::VisualReportBuilder and starts editing a copy of the given VisualReport .
NXOpen::VisualReporting::VisualReportCurrent ()
 Returns the current VisualReporting::VisualReport .
void DeactivateCurrentVisualReport ()
 Deactivates the VisualReporting::VisualReportManager::Current visual report.
NXOpen::VisualReporting::VisualReportMergeReports (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 .
NXOpen::VisualReporting::VisualReportOpen (const NXString &filename)
 Opens an existing VisualReporting::VisualReport , but does not set it to be the VisualReporting::VisualReportManager::Current visual report or activate it.
std::vector
< NXOpen::VisualReporting::VisualReport * > 
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.
void SetCurrent (NXOpen::VisualReporting::VisualReport *visualReport)
 Sets the current VisualReporting::VisualReport .
tag_t Tag () const
 Returns the tag of this object.
void Unload (NXOpen::VisualReporting::VisualReport *visualReport)
 Unloads an opened VisualReporting::VisualReport .
NXOpen::VisualReporting::VisualReportExplorerVisualReportExplorer ()
 Returns the VisualReporting::VisualReportExplorer belonging to this visual report manager
Created in NX7.5.0.
NXOpen::VisualReporting::VisualReportCollectionVisualReports ()
 Returns the VisualReporting::VisualReportCollection belonging to this visual report manager
Created in NX7.0.0.

Detailed Description

A manager for load, creation and activation of visual reports.


To obtain an instance of this class, refer to Session

Created in NX7.0.0.


Member Function Documentation

Activates the VisualReporting::VisualReportManager::Current visual report.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a VisualReporting::SpecifyDateBuilder .

Returns:
The created builder
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a VisualReporting::VisualReportBuilder and starts editing a copy of the given VisualReport .

Returns:
The created builder
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
visualReportThe VisualReport for which this builder is being created. Can be NULL

Returns the current VisualReporting::VisualReport .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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 .

Returns:
merged report
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
visualReportsarray of existing reports
mergedReportNamename of the merged report
NOTE: The full Unicode character set is not supported for this parameter.
mergedReportDescriptiondescription of the merged report
NOTE: The full Unicode character set is not supported for this parameter.

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 VisualReporting::VisualReportManager::OpenReports which can take a container path and list of dataset names

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
filenameThe 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.

Returns:
array of opened reports
Created in NX7.5.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
foldersarray of folders to be searched
NOTE: The full Unicode character set is not supported for this parameter.
namesarray of report names
NOTE: The full Unicode character set is not supported for this parameter.

Sets the current VisualReporting::VisualReport .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
visualReportvisualreport

Returns the tag of this object.

Unloads an opened VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
visualReportvisualreport

Returns the VisualReporting::VisualReportExplorer belonging to this visual report manager
Created in NX7.5.0.


Returns the VisualReporting::VisualReportCollection belonging to this visual report manager
Created in NX7.0.0.



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