NXOpen::AME::PageBuilder Class Reference

Represents a Page creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePageBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::PageBuilder:

Public Types
enum	Types {   TypesAspectStructureOverview, TypesCableDiagram, TypesCableList, TypesOrderList,   TypesPartListBom, TypesPlugList, TypesTableOfContent, TypesTerminalDiagram,   TypesTerminalStripList, TypesTitlePage, TypesWireTubeConnectionLists, TypesWireList,   TypesMultiLineSchematics, TypesSingleLineSchematics, TypesNetworkTopology, TypesPowerSupplyTopology }
	Represents the type of page. More...

Public Member Functions
NXOpen::AME::AspectDetailsBuilder *	Aspects ()
	Returns the Page aspect details Created in NX11.0.0. More...
NXString	Description ()
	Returns the Page description Created in NX11.0.0. More...
NXOpen::AME::PageAttributeHolder *	PageAttributeHolder ()
	Returns the attribute holder Created in NX11.0.0. More...
NXString	PageName ()
	Returns the Page name Created in NX11.0.0. More...
void	SetClassificationCode (const NXString &dccString)
	Set user Classification Code. More...
void	SetClassificationCode (const char *dccString)
	Set user Classification Code. More...
void	SetDefaultClassificationCode ()
	Set default Classification Code. More...
void	SetDescription (const NXString &pageDescription)
	Sets the Page description Created in NX11.0.0. More...
void	SetDescription (const char *pageDescription)
	Sets the Page description Created in NX11.0.0. More...
void	SetPageName (const NXString &pageName)
	Sets the Page name Created in NX11.0.0. More...
void	SetPageName (const char *pageName)
	Sets the Page name Created in NX11.0.0. More...
void	SetType (NXOpen::AME::PageBuilder::Types type)
	Sets the Page type Created in NX11.0.0. More...
NXOpen::AME::PageBuilder::Types	Type ()
	Returns the Page type Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::AME::EngineeringObjectBaseBuilder
std::vector < NXOpen::AME::AspectNode * >	GetCommittedAspects ()
	Get the commited Aspect. More...
Public Member Functions inherited from NXOpen::AME::MultipleObjectsBuilder
std::vector< NXOpen::NXObject * >	GetNewObjects ()
	Get the commited Aspect. More...

Detailed Description

Represents a Page creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePageBuilder
Default values.

Property	Value
PageName	1
Type	MultiLineSchematics

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::AME::PageBuilder::Types

Represents the type of page.

Enumerator
TypesAspectStructureOverview	aspect structure overview
TypesCableDiagram	cable diagram
TypesCableList	cable list
TypesOrderList	order list
TypesPartListBom	part list bom
TypesPlugList	plug list
TypesTableOfContent	table of content
TypesTerminalDiagram	terminal diagram
TypesTerminalStripList	terminal strip list
TypesTitlePage	title page
TypesWireTubeConnectionLists	wire tube connection lists
TypesWireList	wire list
TypesMultiLineSchematics	multi line schematics
TypesSingleLineSchematics	single line schematics
TypesNetworkTopology	network topology
TypesPowerSupplyTopology	power supply topology

Member Function Documentation

NXOpen::AME::AspectDetailsBuilder* NXOpen::AME::PageBuilder::Aspects

(

)

Returns the Page aspect details
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PageBuilder::Description

(

)

Returns the Page description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PageAttributeHolder* NXOpen::AME::PageBuilder::PageAttributeHolder

(

)

Returns the attribute holder
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PageBuilder::PageName

(

)

Returns the Page name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PageBuilder::SetClassificationCode

(

const NXString &

dccString

)

Set user Classification Code.

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

dccString

dccstring

void NXOpen::AME::PageBuilder::SetClassificationCode

(

const char *

dccString

)

Set user Classification Code.

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

dccString

dccstring

void NXOpen::AME::PageBuilder::SetDefaultClassificationCode

(

)

Set default Classification Code.

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PageBuilder::SetDescription

(

const NXString &

pageDescription

)

Sets the Page description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

pageDescription

pagedescription

void NXOpen::AME::PageBuilder::SetDescription

(

const char *

pageDescription

)

Sets the Page description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

pageDescription

pagedescription

void NXOpen::AME::PageBuilder::SetPageName

(

const NXString &

pageName

)

Sets the Page name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

pageName

pagename

void NXOpen::AME::PageBuilder::SetPageName

(

const char *

pageName

)

Sets the Page name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

pageName

pagename

void NXOpen::AME::PageBuilder::SetType

(

NXOpen::AME::PageBuilder::Types

type

)

Sets the Page type
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type

type

NXOpen::AME::PageBuilder::Types NXOpen::AME::PageBuilder::Type

(

)

Returns the Page type
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_PageBuilder.hxx