NX Open C++ Reference Guide
|
A visual report can be activated by the VisualReporting::VisualReportManager to apply colors to objects in the graphics window. More...
A visual report can be activated by the VisualReporting::VisualReportManager to apply colors to objects in the graphics window.
An active visual report groups objects according to filtering conditions and classification rules. The contents of the groups can be accessed via VisualReporting::VisualReport::GetGroupLabels and VisualReporting::VisualReport::GetObjectsInGroup .
Created in NX7.0.0.
Represents the possible VisualReporting::VisualReport::ReportingObjectType for a VisualReporting::VisualReport .
Represents the possible VisualReporting::VisualReport::ReportingStyle for a VisualReporting::VisualReport .
Represents the possible VisualReporting::VisualReport::SaveDestination options for a VisualReporting::VisualReport .
Returns the bitmap name of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Returns the custom message of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Returns the description of this VisualReporting::VisualReport.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Returns the category of this VisualReporting::VisualReport .
Created in NX7.5.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.
Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database. This VisualReporting::VisualReport::DestinationTeamcenterFolder may return NULL if you haven't set a folder name on this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Returns the filename where this VisualReporting::VisualReport was opened from or will be saved to.
Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. If it is a new report, it will be the report dataset name. When the report is save by VisualReporting::VisualReport::Save , the report dataset identifier will be saved in this property.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
std::vector<NXOpen::VisualReporting::Property *> NXOpen::VisualReporting::VisualReport::GetAllDefinedProperties | ( | ) |
Returns the VisualReporting::Property s which has been defined in this VisualReporting::VisualReport .
The returned properties include those properties defined in VisualReporting::Condition s, in VisualReporting::Classifier s, and in the referenced properties.
std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReport::GetGroupLabels | ( | ) |
Returns the result VisualReporting::GroupLabel s from the activated VisualReporting::VisualReport .
There are no VisualReporting::GroupLabel s if the VisualReporting::VisualReport is not activated. You can acess the user defined VisualReporting::GroupLabel s by VisualReporting::VisualReportBuilder::GetManualGroupLabelsOfRule .
std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReport::GetGroupLabelsOfResultCategory | ( | NXOpen::VisualReporting::ResultCategory * | category | ) |
Returns the result VisualReporting::GroupLabel s of a VisualReporting::ResultCategory from the activated VisualReporting::VisualReport .
category | category |
Gets a comma separated string of the keywords for this VisualReporting::VisualReport .
std::vector<NXOpen::NXObject *> NXOpen::VisualReporting::VisualReport::GetObjectsInGroup | ( | NXOpen::VisualReporting::GroupLabel * | groupLabel | ) |
Returns the NXObject s that belong to the group with this VisualReporting::GroupLabel .
groupLabel | A group label of this visual report |
NXString NXOpen::VisualReporting::VisualReport::GetPropertyValueOfObject | ( | NXOpen::VisualReporting::Property * | property, |
NXOpen::VisualReporting::GroupLabel * | groupLabel, | ||
NXOpen::NXObject * | nxObject | ||
) |
Returns the value of the VisualReporting::Property s for the NXObject in the result VisualReporting::GroupLabel .
It will return NULL if the VisualReporting::VisualReport is not activated, or the VisualReporting::Property does not belong to the properties defined in this VisualReporting::VisualReport , or the NXObject doesn't belong to the specified result VisualReporting::GroupLabel .
property | A property defined in this visual report |
groupLabel | A result group of this visual report |
nxObject | A NXObject which belongs to the result group |
std::vector<NXOpen::VisualReporting::ResultCategory *> NXOpen::VisualReporting::VisualReport::GetResultCategories | ( | ) |
Returns the VisualReporting::ResultCategory s from the activated VisualReporting::VisualReport .
There are no VisualReporting::ResultCategory s if the VisualReporting::VisualReport is not activated.
Return the specified VisualReporting::Rule from this VisualReporting::VisualReport.
index | The index of the returned VisualReporting::Rule . |
std::vector<NXOpen::VisualReporting::Rule *> NXOpen::VisualReporting::VisualReport::GetRules | ( | ) |
Returns all the VisualReporting::Rule s in this VisualReporting::VisualReport.
Returns whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
void NXOpen::VisualReporting::VisualReport::RemoveResultCategory | ( | NXOpen::VisualReporting::ResultCategory * | theCategory | ) |
Removes the VisualReporting::ResultCategory from VisualReporting::VisualReport .
The VisualReporting::Classifier which populates this VisualReporting::ResultCategory will also be removed from the VisualReporting::Rule in the VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
theCategory | thecategory |
NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption NXOpen::VisualReporting::VisualReport::ReportingObjectType | ( | ) |
Returns the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
NXOpen::VisualReporting::VisualReport::ReportingStyleOption NXOpen::VisualReporting::VisualReport::ReportingStyle | ( | ) |
Returns the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
Saves this VisualReporting::VisualReport to its current VisualReporting::VisualReport::Filename .
Note that when NX is connected to Teamcenter, the VisualReporting::VisualReport::Filename will be updated to the report dataset identifier after the report is saved to Teamcenter database.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
NXOpen::VisualReporting::VisualReport::SaveDestinationOption NXOpen::VisualReporting::VisualReport::SaveDestination | ( | ) |
Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .
Note that this property will always be VisualReporting::VisualReport::SaveDestinationOptionLocal when NX is not connected to Teamcenter.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
void NXOpen::VisualReporting::VisualReport::SetBitmapName | ( | const NXString & | bitmapName | ) |
Sets the bitmap name of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
bitmapName | bitmapname |
void NXOpen::VisualReporting::VisualReport::SetCustomMessage | ( | const NXString & | customMessage | ) |
Sets the custom message of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
customMessage | custommessage |
void NXOpen::VisualReporting::VisualReport::SetDescription | ( | const NXString & | description | ) |
Sets the description of this VisualReporting::VisualReport.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
description | description |
void NXOpen::VisualReporting::VisualReport::SetDescriptiveCategory | ( | const NXString & | category | ) |
Sets the category of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
category | category |
void NXOpen::VisualReporting::VisualReport::SetDestinationTeamcenterFolder | ( | const NXString & | foldername | ) |
Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.
Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database. This VisualReporting::VisualReport::DestinationTeamcenterFolder may return NULL if you haven't set a folder name on this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
foldername | The Teamcenter folder name |
void NXOpen::VisualReporting::VisualReport::SetFilename | ( | const NXString & | filename | ) |
Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.
Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. If it is a new report, it will be the report dataset name. When the report is save by VisualReporting::VisualReport::Save , the report dataset identifier will be saved in this property.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
filename | filename |
void NXOpen::VisualReporting::VisualReport::SetKeywords | ( | const NXString & | keywords | ) |
Sets a comma separated string of the keywords for this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
keywords | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::VisualReporting::VisualReport::SetReportingObjectType | ( | NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption | reportingObjectType | ) |
Sets the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
reportingObjectType | reportingobjecttype |
void NXOpen::VisualReporting::VisualReport::SetReportingStyle | ( | NXOpen::VisualReporting::VisualReport::ReportingStyleOption | reportingStyle | ) |
Sets the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .
Created in NX7.5.1.
License requirements : nx_visual_reporting ("Visual Reporting")
reportingStyle | reportingstyle |
void NXOpen::VisualReporting::VisualReport::SetSaveDestination | ( | NXOpen::VisualReporting::VisualReport::SaveDestinationOption | destinationOption | ) |
Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .
Note that this property will always be VisualReporting::VisualReport::SaveDestinationOptionLocal when NX is not connected to Teamcenter.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
destinationOption | The destination option |
void NXOpen::VisualReporting::VisualReport::SetUnmatchedGroupEnabled | ( | bool | isUnmatchedGroupEnabled | ) |
Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
isUnmatchedGroupEnabled | Whether the unmatched group is enabled |
Returns the VisualReporting::GroupLabel which is used for unmatched object.
It will return NULL if the VisualReporting::VisualReport is not activated.
Created in NX7.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
NXOpen::VisualReporting::UnmatchedResultCategory* NXOpen::VisualReporting::VisualReport::UnmatchedResultCategory | ( | ) |
Returns the VisualReporting::UnmatchedResultCategory from the activated VisualReporting::VisualReport .
It will return NULL if the VisualReporting::VisualReport is not activated.
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")