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

represents the builder class which is used to define Aspect Prefixes and Delimiter for NXOpen::AME::Project
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAspectPrefixBuilder

Created in NX11.0.0. More...

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

Public Types

enum  DelimiterType { DelimiterTypeDot, DelimiterTypeAspectPrefix, DelimiterTypeNoDelimiter }
 represents delimiter type More...
 

Public Member Functions

bool AutoRenameOnMapping ()
 Returns the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping
Created in NX12.0.0. More...
 
NXOpen::AME::AspectPrefixBuilder::DelimiterType Delimiter ()
 Returns the NXOpen::AME::AspectPrefixBuilder::DelimiterType
Created in NX11.0.0. More...
 
NXString Function ()
 Returns the aspect prefix of function aspect
Created in NX11.0.0. More...
 
NXString Location ()
 Returns the aspect prefix of location aspect
Created in NX11.0.0. More...
 
NXString Product ()
 Returns the aspect prefix of product aspect
Created in NX11.0.0. More...
 
void SetAutoRenameOnMapping (bool autoRenameOnMapping)
 Sets the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping
Created in NX12.0.0. More...
 
void SetDelimiter (NXOpen::AME::AspectPrefixBuilder::DelimiterType delimiter)
 Sets the NXOpen::AME::AspectPrefixBuilder::DelimiterType
Created in NX11.0.0. More...
 
void SetFunction (const NXString &functionPrefix)
 Sets the aspect prefix of function aspect
Created in NX11.0.0. More...
 
void SetFunction (const char *functionPrefix)
 Sets the aspect prefix of function aspect
Created in NX11.0.0. More...
 
void SetLocation (const NXString &location)
 Sets the aspect prefix of location aspect
Created in NX11.0.0. More...
 
void SetLocation (const char *location)
 Sets the aspect prefix of location aspect
Created in NX11.0.0. More...
 
void SetProduct (const NXString &product)
 Sets the aspect prefix of product aspect
Created in NX11.0.0. More...
 
void SetProduct (const char *product)
 Sets the aspect prefix of product aspect
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

represents the builder class which is used to define Aspect Prefixes and Delimiter for NXOpen::AME::Project
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAspectPrefixBuilder

Created in NX11.0.0.


Member Enumeration Documentation

represents delimiter type

Enumerator
DelimiterTypeDot 

A dot (.) is used as the delimiter.

DelimiterTypeAspectPrefix 

Aspect Prefix is used as the delimiter.

DelimiterTypeNoDelimiter 

No delimiter will be used.

Member Function Documentation

bool NXOpen::AME::AspectPrefixBuilder::AutoRenameOnMapping ( )

Returns the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AspectPrefixBuilder::DelimiterType NXOpen::AME::AspectPrefixBuilder::Delimiter ( )

Returns the NXOpen::AME::AspectPrefixBuilder::DelimiterType
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::AspectPrefixBuilder::Function ( )

Returns the aspect prefix of function aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::AspectPrefixBuilder::Location ( )

Returns the aspect prefix of location aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::AspectPrefixBuilder::Product ( )

Returns the aspect prefix of product aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::AspectPrefixBuilder::SetAutoRenameOnMapping ( bool  autoRenameOnMapping)

Sets the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
autoRenameOnMappingautorenameonmapping
void NXOpen::AME::AspectPrefixBuilder::SetDelimiter ( NXOpen::AME::AspectPrefixBuilder::DelimiterType  delimiter)

Sets the NXOpen::AME::AspectPrefixBuilder::DelimiterType
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
delimiterdelimiter
void NXOpen::AME::AspectPrefixBuilder::SetFunction ( const NXString functionPrefix)

Sets the aspect prefix of function aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
functionPrefixfunctionprefix
void NXOpen::AME::AspectPrefixBuilder::SetFunction ( const char *  functionPrefix)

Sets the aspect prefix of function aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
functionPrefixfunctionprefix
void NXOpen::AME::AspectPrefixBuilder::SetLocation ( const NXString location)

Sets the aspect prefix of location aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
locationlocation
void NXOpen::AME::AspectPrefixBuilder::SetLocation ( const char *  location)

Sets the aspect prefix of location aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
locationlocation
void NXOpen::AME::AspectPrefixBuilder::SetProduct ( const NXString product)

Sets the aspect prefix of product aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
productproduct
void NXOpen::AME::AspectPrefixBuilder::SetProduct ( const char *  product)

Sets the aspect prefix of product aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
productproduct

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