|
NX Open C++ Reference Guide
|
A manager for load, creation and activation of visual reports. More...
Public Types | |
| typedef NXOpen::Callback1 < bool, NXOpen::NXObject * > | GetBooleanTypePropertyValue |
| User defined method that is called when ask an boolean property value. More... | |
| typedef NXOpen::Callback1 < NXOpen::NXObject::ComputationalTime, NXOpen::NXObject * > | GetDateTypePropertyValue |
| User defined method that is called when ask an date property value. More... | |
| typedef NXOpen::Callback1< int, NXOpen::NXObject * > | GetIntegerTypePropertyValue |
| User defined method that is called when ask an integer type property value. More... | |
| typedef NXOpen::Callback1 < double, NXOpen::NXObject * > | GetRealTypePropertyValue |
| User defined method that is called when ask an double type property value. More... | |
| typedef NXOpen::Callback1 < NXString, NXOpen::NXObject * > | GetStringTypePropertyValue |
| User defined method that is called when ask an string type property value. More... | |
A manager for load, creation and activation of visual reports.
To obtain an instance of this class, refer to NXOpen::Session
Created in NX7.0.0.
| typedef NXOpen::Callback1<bool, NXOpen::NXObject *> NXOpen::VisualReporting::VisualReportManager::GetBooleanTypePropertyValue |
User defined method that is called when ask an boolean property value.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| typedef NXOpen::Callback1<NXOpen::NXObject::ComputationalTime, NXOpen::NXObject *> NXOpen::VisualReporting::VisualReportManager::GetDateTypePropertyValue |
User defined method that is called when ask an date property value.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| typedef NXOpen::Callback1<int, NXOpen::NXObject *> NXOpen::VisualReporting::VisualReportManager::GetIntegerTypePropertyValue |
User defined method that is called when ask an integer type property value.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| typedef NXOpen::Callback1<double, NXOpen::NXObject *> NXOpen::VisualReporting::VisualReportManager::GetRealTypePropertyValue |
User defined method that is called when ask an double type property value.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| typedef NXOpen::Callback1<NXString, NXOpen::NXObject *> NXOpen::VisualReporting::VisualReportManager::GetStringTypePropertyValue |
User defined method that is called when ask an string type property value.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| void NXOpen::VisualReporting::VisualReportManager::ActivateCurrentVisualReport | ( | ) |
Activates the NXOpen::VisualReporting::VisualReportManager::Current visual report.
Created in NX7.0.0.
License requirements : None
| NXOpen::VisualReporting::SpecifyDateBuilder* NXOpen::VisualReporting::VisualReportManager::CreateSpecifyDateBuilder | ( | ) |
Creates a NXOpen::VisualReporting::SpecifyDateBuilder .
| NXOpen::VisualReporting::VisualReportBuilder* NXOpen::VisualReporting::VisualReportManager::CreateVisualReportBuilder | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Creates a NXOpen::VisualReporting::VisualReportBuilder and starts editing a copy of the given NXOpen::VisualReporting::VisualReport .
| visualReport | The VisualReport for which this builder is being created. Can be NULL |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Current | ( | ) |
Returns the current NXOpen::VisualReporting::VisualReport .
Created in NX7.0.0.
License requirements : None
| void NXOpen::VisualReporting::VisualReportManager::DeactivateCurrentVisualReport | ( | ) |
Deactivates the NXOpen::VisualReporting::VisualReportManager::Current visual report.
Created in NX7.0.0.
License requirements : None
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::MergeReports | ( | const std::vector< NXOpen::VisualReporting::VisualReport * > & | visualReports, |
| const NXString & | mergedReportName, | ||
| const NXString & | mergedReportDescription | ||
| ) |
Merges multiple existing NXOpen::VisualReporting::VisualReport into one NXOpen::VisualReporting::VisualReport , but does not set them to be the NXOpen::VisualReporting::VisualReportManager::Current visual report or activate them, and does not save the merged NXOpen::VisualReporting::VisualReport .
| visualReports | array of existing reports |
| mergedReportName | name of the merged report |
| mergedReportDescription | description of the merged report |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::MergeReports | ( | const std::vector< NXOpen::VisualReporting::VisualReport * > & | visualReports, |
| const char * | mergedReportName, | ||
| const char * | mergedReportDescription | ||
| ) |
Merges multiple existing NXOpen::VisualReporting::VisualReport into one NXOpen::VisualReporting::VisualReport , but does not set them to be the NXOpen::VisualReporting::VisualReportManager::Current visual report or activate them, and does not save the merged NXOpen::VisualReporting::VisualReport .
| visualReports | array of existing reports |
| mergedReportName | name of the merged report |
| mergedReportDescription | description of the merged report |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Open | ( | const NXString & | filename | ) |
Opens an existing NXOpen::VisualReporting::VisualReport , but does not set it to be the NXOpen::VisualReporting::VisualReportManager::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 NXOpen::VisualReporting::VisualReportManager::OpenReports which can take a container path and list of dataset names
| filename | The filename of the visual report to open |
| NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportManager::Open | ( | const char * | filename | ) |
Opens an existing NXOpen::VisualReporting::VisualReport , but does not set it to be the NXOpen::VisualReporting::VisualReportManager::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 NXOpen::VisualReporting::VisualReportManager::OpenReports which can take a container path and list of dataset names
| filename | The filename of the visual report to open |
| std::vector<NXOpen::VisualReporting::VisualReport *> NXOpen::VisualReporting::VisualReportManager::OpenReports | ( | std::vector< NXString > & | folders, |
| std::vector< NXString > & | names | ||
| ) |
Opens existing NXOpen::VisualReporting::VisualReport , but does not set them to be the NXOpen::VisualReporting::VisualReportManager::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 searched |
| names | array of report names |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const NXString & | propertyKey, |
| const NXString & | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetStringTypePropertyValue & | getStringTypePropertyValue | ||
| ) |
Registers a string type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getStringTypePropertyValue | callback function that returns a string type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const char * | propertyKey, |
| const char * | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetStringTypePropertyValue & | getStringTypePropertyValue | ||
| ) |
Registers a string type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getStringTypePropertyValue | callback function that returns a string type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const NXString & | propertyKey, |
| const NXString & | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetIntegerTypePropertyValue & | getIntegerTypePropertyValue | ||
| ) |
Registers an integer type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getIntegerTypePropertyValue | callback function that returns a integer type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const char * | propertyKey, |
| const char * | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetIntegerTypePropertyValue & | getIntegerTypePropertyValue | ||
| ) |
Registers an integer type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getIntegerTypePropertyValue | callback function that returns a integer type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const NXString & | propertyKey, |
| const NXString & | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetRealTypePropertyValue & | getRealTypePropertyValue | ||
| ) |
Registers a double type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getRealTypePropertyValue | callback function that returns a double type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const char * | propertyKey, |
| const char * | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetRealTypePropertyValue & | getRealTypePropertyValue | ||
| ) |
Registers a double type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getRealTypePropertyValue | callback function that returns a double type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const NXString & | propertyKey, |
| const NXString & | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetBooleanTypePropertyValue & | getBooleanTypePropertyValue | ||
| ) |
Registers a boolean type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getBooleanTypePropertyValue | callback function that returns a bool property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const char * | propertyKey, |
| const char * | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetBooleanTypePropertyValue & | getBooleanTypePropertyValue | ||
| ) |
Registers a boolean type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getBooleanTypePropertyValue | callback function that returns a bool property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const NXString & | propertyKey, |
| const NXString & | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetDateTypePropertyValue & | getDateTypePropertyValue | ||
| ) |
Registers a NXOpen::NXObject::ComputationalTime type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getDateTypePropertyValue | callback function that returns a NXOpen::NXObject::ComputationalTime type property value |
| void NXOpen::VisualReporting::VisualReportManager::RegisterProperty | ( | const char * | propertyKey, |
| const char * | propertyName, | ||
| NXOpen::VisualReporting::VisualReport::ScopeTypeOption | scopeType, | ||
| const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & | objectTypes, | ||
| NXOpen::VisualReporting::Property::DatatypeOption | dataType, | ||
| bool | isValidInNative, | ||
| bool | isValidInTeamcenter, | ||
| const NXOpen::VisualReporting::VisualReportManager::GetDateTypePropertyValue & | getDateTypePropertyValue | ||
| ) |
Registers a NXOpen::NXObject::ComputationalTime type property.
The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| propertyName | property name |
| scopeType | property scope type |
| objectTypes | object types |
| dataType | property data type |
| isValidInNative | is property valid in native mode |
| isValidInTeamcenter | is property valid in Teamcenter mode |
| getDateTypePropertyValue | callback function that returns a NXOpen::NXObject::ComputationalTime type property value |
| void NXOpen::VisualReporting::VisualReportManager::SetCurrent | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Sets the current NXOpen::VisualReporting::VisualReport .
Created in NX7.0.0.
License requirements : None
| visualReport | visualreport |
| tag_t NXOpen::VisualReporting::VisualReportManager::Tag | ( | ) | const |
Returns the tag of this object.
| void NXOpen::VisualReporting::VisualReportManager::Unload | ( | NXOpen::VisualReporting::VisualReport * | visualReport | ) |
Unloads an opened NXOpen::VisualReporting::VisualReport .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| visualReport | visualreport |
| void NXOpen::VisualReporting::VisualReportManager::UnregisterProperty | ( | const NXString & | propertyKey | ) |
Unregisters a property.
When the library which the property resides in is unloaded from NX session, this method should be called to unregister the property.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| void NXOpen::VisualReporting::VisualReportManager::UnregisterProperty | ( | const char * | propertyKey | ) |
Unregisters a property.
When the library which the property resides in is unloaded from NX session, this method should be called to unregister the property.
Created in NX12.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
| propertyKey | property key |
| NXOpen::VisualReporting::VisualReportExplorer* NXOpen::VisualReporting::VisualReportManager::VisualReportExplorer | ( | ) |
Returns the NXOpen::VisualReporting::VisualReportExplorer belonging to this visual report manager
Created in NX7.5.0.
| NXOpen::VisualReporting::VisualReportCollection* NXOpen::VisualReporting::VisualReportManager::VisualReports | ( | ) |
Returns the NXOpen::VisualReporting::VisualReportCollection belonging to this visual report manager
Created in NX7.0.0.