NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::AME::ManageTypeMappingBuilder Class Reference

This builder class is used to update relevancy information on the external objects. More...

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

Public Types

enum  DomainRelevancy { DomainRelevancyRelevant, DomainRelevancyUndefined, DomainRelevancyIrrelevant }
 enum for the domain relevancy status filter More...
 

Public Member Functions

void DeleteTypeMapping (const std::vector< NXOpen::Assemblies::Component * > &components)
 Delete existing type mappings for the list of external objects
Created in NX1847.0.0. More...
 
NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy DomainRelevancyOption ()
 Returns the functions to Get/Set the value of domain relevancy option
Created in NX1847.0.0. More...
 
NXOpen::TaggedObjectExternalObjectsSource ()
 Returns the tag of the external objects source
Created in NX1847.0.0. More...
 
NXString PropertyForMapping ()
 Returns the property to use for type mapping
Created in NX1847.0.0. More...
 
void SetDomainRelevancyOption (NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy domainRelevancyOption)
 Sets the functions to Get/Set the value of domain relevancy option
Created in NX1847.0.0. More...
 
void SetExternalObjectsSource (NXOpen::TaggedObject *externalObjectsSource)
 Sets the tag of the external objects source
Created in NX1847.0.0. More...
 
void SetPropertyForMapping (const NXString &propertyName)
 Sets the property to use for type mapping
Created in NX1847.0.0. More...
 
void SetPropertyForMapping (const char *propertyName)
 Sets the property to use for type mapping
Created in NX1847.0.0. More...
 
void SetTypeMappingMode (NXOpen::AME::MappingSourceBuilder::MappingMode mode)
 Sets the mode to use for type mapping
Created in NX1847.0.0. More...
 
NXOpen::AME::MappingSourceBuilder::MappingMode TypeMappingMode ()
 Returns the mode to use for type mapping
Created in NX1847.0.0. More...
 
void UpdateDomainRelevancy (const std::vector< NXOpen::Assemblies::Component * > &components, NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy domainRelevancy)
 Sets the domain relevancy for the list of external objects
Created in NX1847.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

This builder class is used to update relevancy information on the external objects.

This is also used to do the type mapping.
This is an abstract class, and cannot be instantiated.

Created in NX1847.0.0.

Member Enumeration Documentation

enum for the domain relevancy status filter

Enumerator
DomainRelevancyRelevant 

relevant

DomainRelevancyUndefined 

undefined

DomainRelevancyIrrelevant 

irrelevant

Member Function Documentation

void NXOpen::AME::ManageTypeMappingBuilder::DeleteTypeMapping ( const std::vector< NXOpen::Assemblies::Component * > &  components)

Delete existing type mappings for the list of external objects
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
componentscomponents
NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancyOption ( )

Returns the functions to Get/Set the value of domain relevancy option
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::TaggedObject* NXOpen::AME::ManageTypeMappingBuilder::ExternalObjectsSource ( )

Returns the tag of the external objects source
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ManageTypeMappingBuilder::PropertyForMapping ( )

Returns the property to use for type mapping
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ManageTypeMappingBuilder::SetDomainRelevancyOption ( NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy  domainRelevancyOption)

Sets the functions to Get/Set the value of domain relevancy option
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
domainRelevancyOptiondomainrelevancyoption
void NXOpen::AME::ManageTypeMappingBuilder::SetExternalObjectsSource ( NXOpen::TaggedObject externalObjectsSource)

Sets the tag of the external objects source
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
externalObjectsSourceexternalobjectssource
void NXOpen::AME::ManageTypeMappingBuilder::SetPropertyForMapping ( const NXString propertyName)

Sets the property to use for type mapping
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname
void NXOpen::AME::ManageTypeMappingBuilder::SetPropertyForMapping ( const char *  propertyName)

Sets the property to use for type mapping
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname
void NXOpen::AME::ManageTypeMappingBuilder::SetTypeMappingMode ( NXOpen::AME::MappingSourceBuilder::MappingMode  mode)

Sets the mode to use for type mapping
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
modemode
NXOpen::AME::MappingSourceBuilder::MappingMode NXOpen::AME::ManageTypeMappingBuilder::TypeMappingMode ( )

Returns the mode to use for type mapping
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ManageTypeMappingBuilder::UpdateDomainRelevancy ( const std::vector< NXOpen::Assemblies::Component * > &  components,
NXOpen::AME::ManageTypeMappingBuilder::DomainRelevancy  domainRelevancy 
)

Sets the domain relevancy for the list of external objects
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
componentscomponents
domainRelevancydomainrelevancy

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