NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::AME::ReportTemplateBuilder Class Reference

Class to create Report Template and assign the ReportQuery and Report Layout to them
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateReportTemplateBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::ReportTemplateBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString LayoutFileName ()
 Returns the ja function to set the layoutFileName
Created in NX11.0.0. More...
 
NXString QueryFileName ()
 Returns the ja function to set the report query
Created in NX11.0.0. More...
 
NXOpen::AME::PageBuilder::Types ReportType ()
 Returns the enum report type
Created in NX11.0.0. More...
 
void SetLayoutFileName (const NXString &layoutFileName)
 Sets the ja function to set the layoutFileName
Created in NX11.0.0. More...
 
void SetLayoutFileName (const char *layoutFileName)
 Sets the ja function to set the layoutFileName
Created in NX11.0.0. More...
 
void SetQueryFileName (const NXString &queryFileName)
 Sets the ja function to set the report query
Created in NX11.0.0. More...
 
void SetQueryFileName (const char *queryFileName)
 Sets the ja function to set the report query
Created in NX11.0.0. More...
 
void SetReportType (NXOpen::AME::PageBuilder::Types reportType)
 Sets the enum report type
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Class to create Report Template and assign the ReportQuery and Report Layout to them
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateReportTemplateBuilder

Created in NX11.0.0.


Member Function Documentation

NXString NXOpen::AME::ReportTemplateBuilder::LayoutFileName ( )

Returns the ja function to set the layoutFileName
Created in NX11.0.0.



License requirements : None

NXString NXOpen::AME::ReportTemplateBuilder::QueryFileName ( )

Returns the ja function to set the report query
Created in NX11.0.0.



License requirements : None

NXOpen::AME::PageBuilder::Types NXOpen::AME::ReportTemplateBuilder::ReportType ( )

Returns the enum report type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ReportTemplateBuilder::SetLayoutFileName ( const NXString layoutFileName)

Sets the ja function to set the layoutFileName
Created in NX11.0.0.



License requirements : None

Parameters
layoutFileNamelayoutfilename
void NXOpen::AME::ReportTemplateBuilder::SetLayoutFileName ( const char *  layoutFileName)

Sets the ja function to set the layoutFileName
Created in NX11.0.0.



License requirements : None

Parameters
layoutFileNamelayoutfilename
void NXOpen::AME::ReportTemplateBuilder::SetQueryFileName ( const NXString queryFileName)

Sets the ja function to set the report query
Created in NX11.0.0.



License requirements : None

Parameters
queryFileNamequeryfilename
void NXOpen::AME::ReportTemplateBuilder::SetQueryFileName ( const char *  queryFileName)

Sets the ja function to set the report query
Created in NX11.0.0.



License requirements : None

Parameters
queryFileNamequeryfilename
void NXOpen::AME::ReportTemplateBuilder::SetReportType ( NXOpen::AME::PageBuilder::Types  reportType)

Sets the enum report type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
reportTypereporttype

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