NX Open C++ Reference Guide
|
The Explorer of the results of a visual report. More...
Public Types | |
enum | ExploreReportOption { ExploreReportOptionOff, ExploreReportOptionOn } |
Represents whether Explore Report mode is on or off. More... | |
enum | ReportDownStatus { ReportDownStatusNone, ReportDownStatusEnd, ReportDownStatusMore } |
Status reported by NXOpen::VisualReporting::VisualReportExplorer::ReportDown . More... | |
enum | ReportOnObjectsOption { ReportOnObjectsOptionReplace, ReportOnObjectsOptionAdd } |
When the set of objects to report upon is changed, should the contents of the set be replaced or extended. More... | |
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 NXOpen::VisualReporting::VisualReportManager
Created in NX7.5.0.
Status reported by NXOpen::VisualReporting::VisualReportExplorer::ReportDown .
void NXOpen::VisualReporting::VisualReportExplorer::ClearReportObjects | ( | ) |
Remove all objects from the visual report.
Created in NX7.5.0.
License requirements : None
NXOpen::VisualReporting::VisualReportExplorer::ExploreReportOption NXOpen::VisualReporting::VisualReportExplorer::ExploreReport | ( | ) |
Returns the Explore Report setting.
Created in NX7.5.0.
License requirements : None
NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReportExplorer::GetExploringGroup | ( | ) |
Gets the exploring NXOpen::VisualReporting::GroupLabel.
void NXOpen::VisualReporting::VisualReportExplorer::RemoveReportObjects | ( | const std::vector< NXOpen::NXObject * > & | nxObjects | ) |
Remove objects from report.
Created in NX7.5.0.
License requirements : None
nxObjects | Objects to remove from report |
NXOpen::VisualReporting::VisualReportExplorer::ReportDownStatus NXOpen::VisualReporting::VisualReportExplorer::ReportDown | ( | NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjectsOption | reportOnObjectsOption | ) |
Report down the assembly, starting from the NXOpen::Assemblies::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 NXOpen::Assemblies::ComponentAssembly::RootComponent . On subsequent calls, the set of objects currently reported upon will be used as the starting point.
reportOnObjectsOption | Add to or replace objects in report |
NXOpen::VisualReporting::VisualReportExplorer::ReportDownStatus NXOpen::VisualReporting::VisualReportExplorer::ReportDown | ( | const std::vector< NXOpen::NXObject * > & | nxObjects, |
NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjectsOption | reportOnObjectsOption | ||
) |
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 NXOpen::VisualReporting::VisualReportExplorer::ReportDown , with no nxObjects array, the set of objects currently reported upon will be used as the starting point.
nxObjects | Objects from which to start report down operation |
reportOnObjectsOption | Add to or replace objects in report |
void NXOpen::VisualReporting::VisualReportExplorer::ReportOnChildren | ( | const std::vector< NXOpen::NXObject * > & | nxObjects, |
NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjectsOption | reportOnObjectsOption | ||
) |
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 NXOpen::Assemblies::Component s and will report on direct children of the components. If an object is not an instance of NXOpen::Assemblies::Component or if it has no children then nothing will be changed.
Created in NX7.5.0.
License requirements : None
nxObjects | Objects whose children will be reported upon |
reportOnObjectsOption | Add to or replace objects in report |
void NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjects | ( | const std::vector< NXOpen::NXObject * > & | nxObjects, |
NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjectsOption | reportOnObjectsOption | ||
) |
Set objects to report upon.
Created in NX7.5.0.
License requirements : None
nxObjects | Objects to report upon |
reportOnObjectsOption | Add to or replace objects in report |
void NXOpen::VisualReporting::VisualReportExplorer::ReportOnParents | ( | const std::vector< NXOpen::NXObject * > & | nxObjects, |
NXOpen::VisualReporting::VisualReportExplorer::ReportOnObjectsOption | reportOnObjectsOption | ||
) |
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 NXOpen::Assemblies::Component s and will report on the parent of the component. If the object is not an instance of NXOpen::Assemblies::Component or if it has no parent then nothing will be changed.
Created in NX7.5.0.
License requirements : None
nxObjects | Objects whose parents will be reported upon |
reportOnObjectsOption | Add to or replace objects in report |
void NXOpen::VisualReporting::VisualReportExplorer::ResetReportObjects | ( | ) |
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.
Created in NX7.5.0.
License requirements : None
void NXOpen::VisualReporting::VisualReportExplorer::SetExploreReport | ( | NXOpen::VisualReporting::VisualReportExplorer::ExploreReportOption | exploreReportOption | ) |
Sets the Explore Report setting.
Created in NX7.5.0.
License requirements : None
exploreReportOption | explorereportoption |
void NXOpen::VisualReporting::VisualReportExplorer::SetGroupToExplore | ( | NXOpen::VisualReporting::GroupLabel * | groupLabel | ) |
Sets the NXOpen::VisualReporting::GroupLabel to explore.
The NXOpen::VisualReporting::GroupLabel to explore can be set to NULL. If there is no active visual report, then nothing will happen. Note that the NXOpen::VisualReporting::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 .
Created in NX7.5.0.
License requirements : None
groupLabel | The group to explore |
tag_t NXOpen::VisualReporting::VisualReportExplorer::Tag | ( | ) | const |
Returns the tag of this object.