NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::VisualReporting::VisualReport Class Reference

A visual report can be activated by the VisualReporting::VisualReportManager to apply colors to objects in the graphics window. More...

Inheritance diagram for NXOpen::VisualReporting::VisualReport:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  ReportingObjectTypeOption { ReportingObjectTypeOptionPart, ReportingObjectTypeOptionComponent, ReportingObjectTypeOptionInferred }
 Represents the possible VisualReporting::VisualReport::ReportingObjectType for a VisualReporting::VisualReport . More...
enum  ReportingStyleOption { ReportingStyleOptionColorObject, ReportingStyleOptionTagObject, ReportingStyleOptionColorAndTagObject }
 Represents the possible VisualReporting::VisualReport::ReportingStyle for a VisualReporting::VisualReport . More...
enum  SaveDestinationOption { SaveDestinationOptionLocal, SaveDestinationOptionTeamcenter }
 Represents the possible VisualReporting::VisualReport::SaveDestination options for a VisualReporting::VisualReport . More...

Public Member Functions

NXString BitmapName ()
 Returns the bitmap name of this VisualReporting::VisualReport .
NXString CustomMessage ()
 Returns the custom message of this VisualReporting::VisualReport .
NXString Description ()
 Returns the description of this VisualReporting::VisualReport.
NXString DescriptiveCategory ()
 Returns the category of this VisualReporting::VisualReport .
NXString DestinationTeamcenterFolder ()
 Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.
NXString Filename ()
 Returns the filename where this VisualReporting::VisualReport was opened from or will be saved to.
std::vector
< NXOpen::VisualReporting::Property * > 
GetAllDefinedProperties ()
 Returns the VisualReporting::Property s which has been defined in this VisualReporting::VisualReport .
std::vector
< NXOpen::VisualReporting::GroupLabel * > 
GetGroupLabels ()
 Returns the result VisualReporting::GroupLabel s from the activated VisualReporting::VisualReport .
std::vector
< NXOpen::VisualReporting::GroupLabel * > 
GetGroupLabelsOfResultCategory (NXOpen::VisualReporting::ResultCategory *category)
 Returns the result VisualReporting::GroupLabel s of a VisualReporting::ResultCategory from the activated VisualReporting::VisualReport .
NXString GetKeywords ()
 Gets a comma separated string of the keywords for this VisualReporting::VisualReport .
std::vector< NXOpen::NXObject * > GetObjectsInGroup (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Returns the NXObject s that belong to the group with this VisualReporting::GroupLabel .
NXString 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 .
std::vector
< NXOpen::VisualReporting::ResultCategory * > 
GetResultCategories ()
 Returns the VisualReporting::ResultCategory s from the activated VisualReporting::VisualReport .
NXOpen::VisualReporting::RuleGetRule (int index)
 Return the specified VisualReporting::Rule from this VisualReporting::VisualReport.
std::vector
< NXOpen::VisualReporting::Rule * > 
GetRules ()
 Returns all the VisualReporting::Rule s in this VisualReporting::VisualReport.
bool IsUnmatchedGroupEnabled ()
 Returns whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.
void RemoveResultCategory (NXOpen::VisualReporting::ResultCategory *theCategory)
 Removes the VisualReporting::ResultCategory from VisualReporting::VisualReport .
NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption ReportingObjectType ()
 Returns the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .
NXOpen::VisualReporting::VisualReport::ReportingStyleOption ReportingStyle ()
 Returns the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .
void Save ()
 Saves this VisualReporting::VisualReport to its current VisualReporting::VisualReport::Filename .
NXOpen::VisualReporting::VisualReport::SaveDestinationOption SaveDestination ()
 Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .
void SetBitmapName (const NXString &bitmapName)
 Sets the bitmap name of this VisualReporting::VisualReport .
void SetCustomMessage (const NXString &customMessage)
 Sets the custom message of this VisualReporting::VisualReport .
void SetDescription (const NXString &description)
 Sets the description of this VisualReporting::VisualReport.
void SetDescriptiveCategory (const NXString &category)
 Sets the category of this VisualReporting::VisualReport .
void SetDestinationTeamcenterFolder (const NXString &foldername)
 Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport to Teamcenter database.
void SetFilename (const NXString &filename)
 Sets the filename where this VisualReporting::VisualReport was opened from or will be saved to.
void SetKeywords (const NXString &keywords)
 Sets a comma separated string of the keywords for this VisualReporting::VisualReport .
void SetReportingObjectType (NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType)
 Sets the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .
void SetReportingStyle (NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle)
 Sets the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .
void SetSaveDestination (NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption)
 Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport .
void SetUnmatchedGroupEnabled (bool isUnmatchedGroupEnabled)
 Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.
NXOpen::VisualReporting::GroupLabelUnmatchedGroupLabel ()
 Returns the VisualReporting::GroupLabel which is used for unmatched object.
NXOpen::VisualReporting::UnmatchedResultCategoryUnmatchedResultCategory ()
 Returns the VisualReporting::UnmatchedResultCategory from the activated VisualReporting::VisualReport .

Detailed Description

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.


Member Enumeration Documentation

Represents the possible VisualReporting::VisualReport::ReportingObjectType for a VisualReporting::VisualReport .

Enumerator:
ReportingObjectTypeOptionPart 

The reporting objects are parts.

ReportingObjectTypeOptionComponent 

The reporting objects are components.

ReportingObjectTypeOptionInferred 

The reporting objects are inferred from the properties used in the report.

Represents the possible VisualReporting::VisualReport::ReportingStyle for a VisualReporting::VisualReport .

Enumerator:
ReportingStyleOptionColorObject 

Matching objects will be colored.

ReportingStyleOptionTagObject 

Matching objects will be tagged.

ReportingStyleOptionColorAndTagObject 

Matching objects will be both colored and tagged.

Represents the possible VisualReporting::VisualReport::SaveDestination options for a VisualReporting::VisualReport .

Enumerator:
SaveDestinationOptionLocal 

Saves the report in the local file system.

SaveDestinationOptionTeamcenter 

Saves the report in the Teamcenter database.


Member Function Documentation

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")

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.

Returns:
Properties defined in this visual report
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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 .

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the result VisualReporting::GroupLabel s of a VisualReporting::ResultCategory from the activated VisualReporting::VisualReport .

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
categorycategory

Gets a comma separated string of the keywords for this VisualReporting::VisualReport .

Returns:

Created in NX7.5.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the NXObject s that belong to the group with this VisualReporting::GroupLabel .

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelA group label of this visual report

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 .

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyA property defined in this visual report
groupLabelA result group of this visual report
nxObjectA NXObject which belongs to the result group

Returns the VisualReporting::ResultCategory s from the activated VisualReporting::VisualReport .

There are no VisualReporting::ResultCategory s if the VisualReporting::VisualReport is not activated.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Return the specified VisualReporting::Rule from this VisualReporting::VisualReport.

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
indexThe index of the returned VisualReporting::Rule .

Returns all the VisualReporting::Rule s in this VisualReporting::VisualReport.

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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")

Parameters:
theCategorythecategory

Returns the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

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")

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")

Sets the bitmap name of this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
bitmapNamebitmapname

Sets the custom message of this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
customMessagecustommessage

Sets the description of this VisualReporting::VisualReport.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
descriptiondescription

Sets the category of this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
categorycategory

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")

Parameters:
foldernameThe Teamcenter folder name

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")

Parameters:
filenamefilename

Sets a comma separated string of the keywords for this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
keywords
NOTE: The full Unicode character set is not supported for this parameter.

Sets the VisualReporting::VisualReport::ReportingObjectTypeOption of this VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
reportingObjectTypereportingobjecttype

Sets the VisualReporting::VisualReport::ReportingStyleOption of this VisualReporting::VisualReport .


Created in NX7.5.1.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
reportingStylereportingstyle

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")

Parameters:
destinationOptionThe destination option

Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
isUnmatchedGroupEnabledWhether 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")

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")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.