NXOpen::AME::ReportsSettingsBuilder Class Reference

interface for the ReportsSettingsBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateReportsSettingsBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::ReportsSettingsBuilder:

Public Member Functions
void	AddRule ()
	Add new report rule Created in NX11.0.0. More...
bool	FunctionAspect ()
	Returns the function aspect Created in NX11.0.0. More...
bool	LocationAspect ()
	Returns the location aspect Created in NX11.0.0. More...
bool	ProductAspect ()
	Returns the product aspect Created in NX11.0.0. More...
void	RemoveRule ()
	Remove report rule Created in NX11.0.0. More...
NXString	ReportName ()
	Returns the string report name Created in NX11.0.0. More...
NXString	ReportTemplateName ()
	Returns the report template name Created in NX11.0.0. More...
NXOpen::AME::PageBuilder::Types	ReportType ()
	Returns the selected report template type Created in NX11.0.0. More...
NXOpen::AME::SelectClassificationBuilder *	SelectClassification ()
	Returns the selected classification Created in NX11.0.0. More...
int	SelectedRule ()
	Returns the selected report rule Created in NX11.0.0. More...
void	SetFunctionAspect (bool functionAspect)
	Sets the function aspect Created in NX11.0.0. More...
void	SetLocationAspect (bool locationAspect)
	Sets the location aspect Created in NX11.0.0. More...
void	SetProductAspect (bool productAspect)
	Sets the product aspect Created in NX11.0.0. More...
void	SetReportName (const NXString &reportName)
	Sets the string report name Created in NX11.0.0. More...
void	SetReportName (const char *reportName)
	Sets the string report name Created in NX11.0.0. More...
void	SetReportTemplateName (const NXString &reportTemplateName)
	Sets the report template name Created in NX11.0.0. More...
void	SetReportTemplateName (const char *reportTemplateName)
	Sets the report template name Created in NX11.0.0. More...
void	SetReportType (NXOpen::AME::PageBuilder::Types reportType)
	Sets the selected report template type Created in NX11.0.0. More...
void	SetSelectedRule (int selectedRule)
	Sets the selected report rule Created in NX11.0.0. More...
void	SetWholeProjectToggle (bool wholeProjectToggle)
	Sets the whole project toggle Created in NX11.0.0. More...
bool	WholeProjectToggle ()
	Returns the whole project toggle Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

interface for the ReportsSettingsBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateReportsSettingsBuilder

Created in NX11.0.0.

Member Function Documentation

void NXOpen::AME::ReportsSettingsBuilder::AddRule

(

)

Add new report rule
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ReportsSettingsBuilder::FunctionAspect

(

)

Returns the function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ReportsSettingsBuilder::LocationAspect

(

)

Returns the location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ReportsSettingsBuilder::ProductAspect

(

)

Returns the product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ReportsSettingsBuilder::RemoveRule

(

)

Remove report rule
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ReportsSettingsBuilder::ReportName

(

)

Returns the string report name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ReportsSettingsBuilder::ReportTemplateName

(

)

Returns the report template name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PageBuilder::Types NXOpen::AME::ReportsSettingsBuilder::ReportType

(

)

Returns the selected report template type
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectClassificationBuilder* NXOpen::AME::ReportsSettingsBuilder::SelectClassification

(

)

Returns the selected classification
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::ReportsSettingsBuilder::SelectedRule

(

)

Returns the selected report rule
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ReportsSettingsBuilder::SetFunctionAspect

(

bool

functionAspect

)

Sets the function aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

functionAspect

functionaspect

void NXOpen::AME::ReportsSettingsBuilder::SetLocationAspect

(

bool

locationAspect

)

Sets the location aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

locationAspect

locationaspect

void NXOpen::AME::ReportsSettingsBuilder::SetProductAspect

(

bool

productAspect

)

Sets the product aspect
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

productAspect

productaspect

void NXOpen::AME::ReportsSettingsBuilder::SetReportName

(

const NXString &

reportName

)

Sets the string report name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

reportName

reportname

void NXOpen::AME::ReportsSettingsBuilder::SetReportName

(

const char *

reportName

)

Sets the string report name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

reportName

reportname

void NXOpen::AME::ReportsSettingsBuilder::SetReportTemplateName

(

const NXString &

reportTemplateName

)

Sets the report template name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

reportTemplateName

reporttemplatename

void NXOpen::AME::ReportsSettingsBuilder::SetReportTemplateName

(

const char *

reportTemplateName

)

Sets the report template name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

reportTemplateName

reporttemplatename

void NXOpen::AME::ReportsSettingsBuilder::SetReportType

(

NXOpen::AME::PageBuilder::Types

reportType

)

Sets the selected report template type
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

reportType

reporttype

void NXOpen::AME::ReportsSettingsBuilder::SetSelectedRule

(

int

selectedRule

)

Sets the selected report rule
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

selectedRule

selectedrule

void NXOpen::AME::ReportsSettingsBuilder::SetWholeProjectToggle

(

bool

wholeProjectToggle

)

Sets the whole project toggle
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

wholeProjectToggle

wholeprojecttoggle

bool NXOpen::AME::ReportsSettingsBuilder::WholeProjectToggle

(

)

Returns the whole project toggle
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

---

The documentation for this class was generated from the following file:

• AME_ReportsSettingsBuilder.hxx