nxopen.visualreporting

Interface VisualReportExplorer

All Superinterfaces:

Remote

public interface VisualReportExplorer
extends Remote

The Explorer of the results of a visual report. The Visual Report Explorer enables a report to focus on specified objects or on a particular group in the visual report.
To obtain an instance of this class, refer to VisualReportManager

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VisualReportExplorer.ExploreReportOption Represents whether Explore Report mode is on or off.
static class	VisualReportExplorer.ReportDownStatus Status reported by reportDown(nxopen.visualreporting.VisualReportExplorer.ReportOnObjectsOption) .
static class	VisualReportExplorer.ReportOnObjectsOption When the set of objects to report upon is changed, should the contents of the set be replaced or extended.

Method Summary

Modifier and Type	Method and Description
void	clearReportObjects() Remove all objects from the visual report.
VisualReportExplorer.ExploreReportOption	exploreReport() Returns the Explore Report setting License requirements: None.
GroupLabel	getExploringGroup() Gets the exploring GroupLabel License requirements: None.
void	removeReportObjects(NXObject[] nxObjects) Remove objects from report.
VisualReportExplorer.ReportDownStatus	reportDown(NXObject[] nxObjects, VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption) Report down from a starting array of objects.
VisualReportExplorer.ReportDownStatus	reportDown(VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption) Report down the assembly, starting from the ComponentAssembly.rootComponent() .
void	reportOnChildren(NXObject[] nxObjects, VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption) Report on the children of nxObjects.
void	reportOnObjects(NXObject[] nxObjects, VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption) Set objects to report upon.
void	reportOnParents(NXObject[] nxObjects, VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption) Report on the parents of the nxObjects.
void	resetReportObjects() Resets the objects to report upon.
void	setExploreReport(VisualReportExplorer.ExploreReportOption exploreReportOption) License requirements: None.
void	setGroupToExplore(GroupLabel groupLabel) Sets the GroupLabel to explore.

Method Detail

exploreReport

VisualReportExplorer.ExploreReportOption exploreReport()
                                                throws NXException,
                                                       RemoteException

Returns the Explore Report setting
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setExploreReport

void setExploreReport(VisualReportExplorer.ExploreReportOption exploreReportOption)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

exploreReportOption -

Throws:

NXException

RemoteException

reportOnObjects

void reportOnObjects(NXObject[] nxObjects,
                     VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
              throws NXException,
                     RemoteException

Set objects to report upon.
License requirements: None.

Created in NX7.5.0

Parameters:

nxObjects - Objects to report upon

reportOnObjectsOption - Add to or replace objects in report

Throws:

NXException

RemoteException

removeReportObjects

void removeReportObjects(NXObject[] nxObjects)
                  throws NXException,
                         RemoteException

Remove objects from report.
License requirements: None.

Created in NX7.5.0

Parameters:

nxObjects - Objects to remove from report

Throws:

NXException

RemoteException

clearReportObjects

void clearReportObjects()
                 throws NXException,
                        RemoteException

Remove all objects from the visual report.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

resetReportObjects

void resetReportObjects()
                 throws NXException,
                        RemoteException

Resets the objects to report upon. If there is no group to explore set, then all leaf nodes of the assembly will be included in the report. If a group to explore is set, then elements of that group will be reported upon. Where there are two elements of the group on the same branch of the assembly, the lowest will be reported upon.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

getExploringGroup

GroupLabel getExploringGroup()
                      throws NXException,
                             RemoteException

Gets the exploring GroupLabel
License requirements: None.

Created in NX8.0.0

Returns:

The exploring group

Throws:

NXException

RemoteException

setGroupToExplore

void setGroupToExplore(GroupLabel groupLabel)
                throws NXException,
                       RemoteException

Sets the GroupLabel to explore. The GroupLabel to explore can be set to null. If there is no active visual report, then nothing will happen. Note that the GroupLabel should belong to the active visual report otherwise the call will fail. This method will also cause the objects reported upon to be reset in the same way as a call to resetReportObjects() .
License requirements: None.

Created in NX7.5.0

Parameters:

groupLabel - The group to explore

Throws:

NXException

RemoteException

reportDown

VisualReportExplorer.ReportDownStatus reportDown(VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
                                          throws NXException,
                                                 RemoteException

Report down the assembly, starting from the ComponentAssembly.rootComponent() . A group to explore should have been specified for this method to have any effect. The first time this method is called the operation will start from ComponentAssembly.rootComponent() . On subsequent calls, the set of objects currently reported upon will be used as the starting point.
License requirements: None.

Created in NX7.5.0

Parameters:

reportOnObjectsOption - Add to or replace objects in report

Returns:

Status from the report down operation

Throws:

NXException

RemoteException

reportDown

VisualReportExplorer.ReportDownStatus reportDown(NXObject[] nxObjects,
                                                 VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
                                          throws NXException,
                                                 RemoteException

Report down from a starting array of objects. A group to explore should have been specified for this method to have any effect. On subsequent calls to reportDown(nxopen.visualreporting.VisualReportExplorer.ReportOnObjectsOption) , with no nxObjects array, the set of objects currently reported upon will be used as the starting point.
License requirements: None.

Created in NX7.5.0

Parameters:

nxObjects - Objects from which to start report down operation

reportOnObjectsOption - Add to or replace objects in report

Returns:

Status from the report down operation

Throws:

NXException

RemoteException

reportOnChildren

void reportOnChildren(NXObject[] nxObjects,
                      VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
               throws NXException,
                      RemoteException

Report on the children of nxObjects. The children will either replace the existing contents of the report or be added to the report. This operation is intended for Component s and will report on direct children of the components. If an object is not an instance of Component or if it has no children then nothing will be changed.
License requirements: None.

Created in NX7.5.0

Parameters:

nxObjects - Objects whose children will be reported upon

reportOnObjectsOption - Add to or replace objects in report

Throws:

NXException

RemoteException

reportOnParents

void reportOnParents(NXObject[] nxObjects,
                     VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
              throws NXException,
                     RemoteException

Report on the parents of the nxObjects. The parents will either replace the existing contents of the report or be added to the report. This operation is intended for Component s and will report on the parent of the component. If the object is not an instance of Component or if it has no parent then nothing will be changed.
License requirements: None.

Created in NX7.5.0

Parameters:

nxObjects - Objects whose parents will be reported upon

reportOnObjectsOption - Add to or replace objects in report

Throws:

NXException

RemoteException