NXOpen::AME::InstantiateTemplateBulkBuilder Class Reference

JA class for the insert Eng object dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInstantiateTemplateBulkBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::InstantiateTemplateBulkBuilder:

Public Types
enum	PlacementType { PlacementTypeNavigator, PlacementTypePage }
	Choices for placement type, can be Place in Navigator or Place on Page. More...

Public Member Functions
NXOpen::AME::AspectDetailsBuilder *	AspectDetails ()
	Returns the aspect details ui block Created in NX12.0.0. More...
bool	CopyDocumentStructure ()
	Returns the copy document structure flag to decide whether to copy document structure Created in NX12.0.0. More...
NXOpen::Point2d	FragmentLocation ()
	Returns the co-ordinate of fragment placement location Created in NX12.0.0. More...
NXOpen::AME::Project *	GetProjectFromPartFileName ()
	Get Project from part file. More...
NXOpen::AME::InsertSettingsBuilder *	InsertSettings ()
	Returns the aspect placement toggle setting Created in NX12.0.0. More...
NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementType	PlacementValue ()
	Returns the placement type Created in NX12.0.0. More...
NXOpen::Tooling::SelectReuseLibraryItemBuilder *	ReuseLibraryItem ()
	Returns the reuse library selection item Created in NX12.0.0. More...
NXOpen::AME::FragmentObject *	SelectedFragmentTag ()
	Returns the tag of selected fragment object Created in NX12.0.0. More...
NXOpen::AME::SelectAMEBaseNodeList *	SelectedObjects ()
	Returns the select object Created in NX12.0.0. More...
void	SetCopyDocumentStructure (bool copyDocumentStructure)
	Sets the copy document structure flag to decide whether to copy document structure Created in NX12.0.0. More...
void	SetFragmentLocation (const NXOpen::Point2d &fragmentLocation)
	Sets the co-ordinate of fragment placement location Created in NX12.0.0. More...
void	SetPlacementValue (NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementType placementType)
	Sets the placement type Created in NX12.0.0. More...
void	SetSelectedFragmentTag (NXOpen::AME::FragmentObject *selectedFragmentTag)
	Sets the tag of selected fragment object Created in NX12.0.0. More...
void	SetShowInAutomation (bool showInAutomation)
	Sets the show in automation Created in NX12.0.0. More...
void	SetShowInFunction (bool showInFunction)
	Sets the show in function Created in NX12.0.0. More...
void	SetShowInLocation (bool showInLocation)
	Sets the show in location Created in NX12.0.0. More...
void	SetShowInProduct (bool showInProduct)
	Sets the show in product Created in NX12.0.0. More...
void	SetUnloadTemplate (bool unloadTemplate)
	Sets the unload template flag to indicate if template should be unloaded after instantiation Created in NX12.0.0. More...
bool	ShowInAutomation ()
	Returns the show in automation Created in NX12.0.0. More...
bool	ShowInFunction ()
	Returns the show in function Created in NX12.0.0. More...
bool	ShowInLocation ()
	Returns the show in location Created in NX12.0.0. More...
bool	ShowInProduct ()
	Returns the show in product Created in NX12.0.0. More...
NXOpen::NXObject *	TemplateInstance ()
	Returns the created instance Created in NX12.0.0. More...
bool	UnloadTemplate ()
	Returns the unload template flag to indicate if template should be unloaded after instantiation Created in NX12.0.0. More...
Public Member Functions inherited from NXOpen::AME::MultipleObjectsBuilder
std::vector< NXOpen::NXObject * >	GetNewObjects ()
	Get the commited Aspect. More...

Detailed Description

JA class for the insert Eng object dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInstantiateTemplateBulkBuilder
Default values.

Property	Value
InsertSettings.AspectPlacement	false
InsertSettings.CopiesPerParent	1
ShowInAutomation	false
ShowInFunction	false
ShowInLocation	false
ShowInProduct	false

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementType

Choices for placement type, can be Place in Navigator or Place on Page.

Enumerator
PlacementTypeNavigator	navigator
PlacementTypePage	page

Member Function Documentation

NXOpen::AME::AspectDetailsBuilder* NXOpen::AME::InstantiateTemplateBulkBuilder::AspectDetails

(

)

Returns the aspect details ui block
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::InstantiateTemplateBulkBuilder::CopyDocumentStructure

(

)

Returns the copy document structure flag to decide whether to copy document structure
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Point2d NXOpen::AME::InstantiateTemplateBulkBuilder::FragmentLocation

(

)

Returns the co-ordinate of fragment placement location
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::Project* NXOpen::AME::InstantiateTemplateBulkBuilder::GetProjectFromPartFileName

(

)

Get Project from part file.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::InsertSettingsBuilder* NXOpen::AME::InstantiateTemplateBulkBuilder::InsertSettings

(

)

Returns the aspect placement toggle setting
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementType NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementValue

(

)

Returns the placement type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::InstantiateTemplateBulkBuilder::ReuseLibraryItem

(

)

Returns the reuse library selection item
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::FragmentObject* NXOpen::AME::InstantiateTemplateBulkBuilder::SelectedFragmentTag

(

)

Returns the tag of selected fragment object
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNodeList* NXOpen::AME::InstantiateTemplateBulkBuilder::SelectedObjects

(

)

Returns the select object
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetCopyDocumentStructure

(

bool

copyDocumentStructure

)

Sets the copy document structure flag to decide whether to copy document structure
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

copyDocumentStructure

copydocumentstructure

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetFragmentLocation

(

const NXOpen::Point2d &

fragmentLocation

)

Sets the co-ordinate of fragment placement location
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

fragmentLocation

fragmentlocation

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetPlacementValue

(

NXOpen::AME::InstantiateTemplateBulkBuilder::PlacementType

placementType

)

Sets the placement type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

placementType

placementtype

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetSelectedFragmentTag

(

NXOpen::AME::FragmentObject *

selectedFragmentTag

)

Sets the tag of selected fragment object
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

selectedFragmentTag

selectedfragmenttag

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetShowInAutomation

(

bool

showInAutomation

)

Sets the show in automation
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

showInAutomation

showinautomation

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetShowInFunction

(

bool

showInFunction

)

Sets the show in function
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

showInFunction

showinfunction

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetShowInLocation

(

bool

showInLocation

)

Sets the show in location
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

showInLocation

showinlocation

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetShowInProduct

(

bool

showInProduct

)

Sets the show in product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

showInProduct

showinproduct

void NXOpen::AME::InstantiateTemplateBulkBuilder::SetUnloadTemplate

(

bool

unloadTemplate

)

Sets the unload template flag to indicate if template should be unloaded after instantiation
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

unloadTemplate

unloadtemplate

bool NXOpen::AME::InstantiateTemplateBulkBuilder::ShowInAutomation

(

)

Returns the show in automation
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::InstantiateTemplateBulkBuilder::ShowInFunction

(

)

Returns the show in function
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::InstantiateTemplateBulkBuilder::ShowInLocation

(

)

Returns the show in location
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::InstantiateTemplateBulkBuilder::ShowInProduct

(

)

Returns the show in product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::NXObject* NXOpen::AME::InstantiateTemplateBulkBuilder::TemplateInstance

(

)

Returns the created instance
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::InstantiateTemplateBulkBuilder::UnloadTemplate

(

)

Returns the unload template flag to indicate if template should be unloaded after instantiation
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

---

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

• AME_InstantiateTemplateBulkBuilder.hxx