Modifier and Type | Method and Description |
---|---|
void |
activateCurrentVisualReport()
Activates the
current() visual report. |
SpecifyDateBuilder |
createSpecifyDateBuilder()
Creates a
SpecifyDateBuilder . |
VisualReportBuilder |
createVisualReportBuilder(VisualReport visualReport)
Creates a
VisualReportBuilder and starts
editing a copy of the given VisualReport . |
VisualReport |
current()
Returns
the current
VisualReport . |
void |
deactivateCurrentVisualReport()
Deactivates the
current() visual report. |
VisualReport |
mergeReports(VisualReport[] visualReports,
String mergedReportName,
String mergedReportDescription)
Merges multiple existing
VisualReport into one VisualReport , but does not set them to be the
current() visual report or activate them, and does not save the merged VisualReport . |
VisualReport |
open(String filename)
Opens an existing
VisualReport , but does not set it to be the
current() visual report or activate it. |
VisualReport[] |
openReports(String[] folders,
String[] names)
Opens existing
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
VisualReport . |
VisualReportExplorer |
visualReportExplorer()
|
VisualReportCollection |
visualReports()
|
VisualReportCollection visualReports() throws RemoteException
RemoteException
VisualReportExplorer visualReportExplorer() throws RemoteException
RemoteException
VisualReportBuilder createVisualReportBuilder(VisualReport visualReport) throws NXException, RemoteException
VisualReportBuilder
and starts
editing a copy of the given VisualReport
.
visualReport
- The VisualReport for which this builder is being created. Can be nullNXException
RemoteException
VisualReport open(String filename) throws NXException, RemoteException
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
filename
- The filename of the visual report to openNXException
RemoteException
void unload(VisualReport visualReport) throws NXException, RemoteException
VisualReport
.
visualReport
- NXException
RemoteException
VisualReport[] openReports(String[] folders, String[] names) throws NXException, RemoteException
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.
folders
- array of folders to be searchednames
- array of report namesNXException
RemoteException
void activateCurrentVisualReport() throws NXException, RemoteException
NXException
RemoteException
void deactivateCurrentVisualReport() throws NXException, RemoteException
NXException
RemoteException
VisualReport current() throws NXException, RemoteException
NXException
RemoteException
void setCurrent(VisualReport visualReport) throws NXException, RemoteException
visualReport
- NXException
RemoteException
VisualReport mergeReports(VisualReport[] visualReports, String mergedReportName, String mergedReportDescription) throws NXException, RemoteException
VisualReport
into one VisualReport
, but does not set them to be the
current()
visual report or activate them, and does not save the merged VisualReport
.
visualReports
- array of existing reportsmergedReportName
- name of the merged reportmergedReportDescription
- description of the merged reportNXException
RemoteException
SpecifyDateBuilder createSpecifyDateBuilder() throws NXException, RemoteException
NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.