nxopen.visualreporting

Interface VisualReportManager

All Superinterfaces:

Remote

public interface VisualReportManager
extends Remote

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

Method Summary

Modifier and Type	Method and Description
void	activateCurrentVisualReport() Activates the current() visual report.
SpecifyDateBuilder	createSpecifyDateBuilder() Creates a SpecifyDateBuilder .
VisualReportBuilder	createVisualReportBuilder(VisualReport visualReport) Creates a nxopen.visualreporting.VisualReportBuilder and starts editing a copy of the given nxopen.visualreporting.VisualReport .
VisualReport	current() Returns the current nxopen.visualreporting.VisualReport .
void	deactivateCurrentVisualReport() Deactivates the current() visual report.
VisualReport	mergeReports(VisualReport[] visualReports, String mergedReportName, String mergedReportDescription) Merges multiple existing nxopen.visualreporting.VisualReport into one nxopen.visualreporting.VisualReport , but does not set them to be the current() visual report or activate them, and does not save the merged nxopen.visualreporting.VisualReport .
VisualReport	open(String filename) Opens an existing nxopen.visualreporting.VisualReport , but does not set it to be the current() visual report or activate it.
VisualReport[]	openReports(String[] folders, String[] names) Opens existing nxopen.visualreporting.VisualReport , but does not set them to be the current() visual report or activate them.
void	setCurrent(VisualReport visualReport) License requirements: None.
void	unload(VisualReport visualReport) Unloads an opened nxopen.visualreporting.VisualReport .
VisualReportExplorer	visualReportExplorer() Returns the VisualReportExplorer belonging to this visual report manager Created in NX7.5.0
nxopen.visualreporting.VisualReportCollection	visualReports() Returns the nxopen.visualreporting.VisualReportCollection belonging to this visual report manager Created in NX7.0.0

Method Detail

visualReports

nxopen.visualreporting.VisualReportCollection visualReports()
                                                     throws RemoteException

Returns the nxopen.visualreporting.VisualReportCollection belonging to this visual report manager
Created in NX7.0.0

Throws:

RemoteException

visualReportExplorer

VisualReportExplorer visualReportExplorer()
                                   throws RemoteException

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

Throws:

RemoteException

createVisualReportBuilder

VisualReportBuilder createVisualReportBuilder(VisualReport visualReport)
                                       throws NXException,
                                              RemoteException

Creates a nxopen.visualreporting.VisualReportBuilder and starts editing a copy of the given nxopen.visualreporting.VisualReport .
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX7.0.0

Parameters:

visualReport - The VisualReport for which this builder is being created. Can be null

Returns:

The created builder

Throws:

NXException

RemoteException

open

VisualReport open(String filename)
           throws NXException,
                  RemoteException

Opens an existing nxopen.visualreporting.VisualReport , but does not set it to be the 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 openReports(java.lang.String[], java.lang.String[]) which can take a container path and list of dataset names
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX7.0.0

Parameters:

filename - The filename of the visual report to open
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

unload

void unload(VisualReport visualReport)
     throws NXException,
            RemoteException

Unloads an opened nxopen.visualreporting.VisualReport .
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX8.0.0

Parameters:

visualReport -

Throws:

NXException

RemoteException

openReports

VisualReport[] openReports(String[] folders,
                           String[] names)
                    throws NXException,
                           RemoteException

Opens existing nxopen.visualreporting.VisualReport , but does not set them to be the 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.
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX7.5.0

Parameters:

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.

Returns:

array of opened reports

Throws:

NXException

RemoteException

activateCurrentVisualReport

void activateCurrentVisualReport()
                          throws NXException,
                                 RemoteException

Activates the current() visual report.
License requirements: None.

Created in NX7.0.0

Throws:

NXException

RemoteException

deactivateCurrentVisualReport

void deactivateCurrentVisualReport()
                            throws NXException,
                                   RemoteException

Deactivates the current() visual report.
License requirements: None.

Created in NX7.0.0

Throws:

NXException

RemoteException

current

VisualReport current()
              throws NXException,
                     RemoteException

Returns the current nxopen.visualreporting.VisualReport .
License requirements: None.

Created in NX7.0.0

Throws:

NXException

RemoteException

setCurrent

void setCurrent(VisualReport visualReport)
         throws NXException,
                RemoteException

License requirements: None.

Created in NX7.0.0

Parameters:

visualReport -

Throws:

NXException

RemoteException

mergeReports

VisualReport mergeReports(VisualReport[] visualReports,
                          String mergedReportName,
                          String mergedReportDescription)
                   throws NXException,
                          RemoteException

Merges multiple existing nxopen.visualreporting.VisualReport into one nxopen.visualreporting.VisualReport , but does not set them to be the current() visual report or activate them, and does not save the merged nxopen.visualreporting.VisualReport .
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX8.0.0

Parameters:

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.

Returns:

merged report

Throws:

NXException

RemoteException

createSpecifyDateBuilder

SpecifyDateBuilder createSpecifyDateBuilder()
                                     throws NXException,
                                            RemoteException

Creates a SpecifyDateBuilder .
License requirements: None.

Created in NX8.0.0

Returns:

The created builder

Throws:

NXException

RemoteException