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::MappingSourceBuilder Class Reference

This builder class is a re-usable component used to filter external objects by discipline. More...

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

Public Types

enum  MappingMode { MappingModeMechanicalObject, MappingModeAutomationIdAsProperty, MappingModeMechanicalTypeAsProperty }
 possible choices for type mapping mode More...
 

Public Member Functions

int ExternalObjectsSource ()
 Returns the functions to Get/Set the mapping source input
Created in NX1847.0.0. More...
 
NXString MappingProperty ()
 Returns the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0. More...
 
void SetExternalObjectsSource (int externalObjectSourceIndex)
 Sets the functions to Get/Set the mapping source input
Created in NX1847.0.0. More...
 
void SetMappingProperty (const NXString &mappingProperty)
 Sets the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0. More...
 
void SetMappingProperty (const char *mappingProperty)
 Sets the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0. More...
 
void SetTypeMappingMode (NXOpen::AME::MappingSourceBuilder::MappingMode mode)
 Sets the functions to Get/Set the NXOpen::AME::MappingSourceBuilder::MappingMode
Created in NX1847.0.0. More...
 
NXOpen::AME::MappingSourceBuilder::MappingMode TypeMappingMode ()
 Returns the functions to Get/Set the NXOpen::AME::MappingSourceBuilder::MappingMode
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 a re-usable component used to filter external objects by discipline.

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

Created in NX1847.0.0.

Member Enumeration Documentation

possible choices for type mapping mode

Enumerator
MappingModeMechanicalObject 

mechanical object

MappingModeAutomationIdAsProperty 

automation id as property

MappingModeMechanicalTypeAsProperty 

mechanical type as property

Member Function Documentation

int NXOpen::AME::MappingSourceBuilder::ExternalObjectsSource ( )

Returns the functions to Get/Set the mapping source input
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::MappingSourceBuilder::MappingProperty ( )

Returns the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::MappingSourceBuilder::SetExternalObjectsSource ( int  externalObjectSourceIndex)

Sets the functions to Get/Set the mapping source input
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
externalObjectSourceIndexexternalobjectsourceindex
void NXOpen::AME::MappingSourceBuilder::SetMappingProperty ( const NXString mappingProperty)

Sets the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
mappingPropertymappingproperty
void NXOpen::AME::MappingSourceBuilder::SetMappingProperty ( const char *  mappingProperty)

Sets the property to use for type mapping by mechanical or automation id
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
mappingPropertymappingproperty
void NXOpen::AME::MappingSourceBuilder::SetTypeMappingMode ( NXOpen::AME::MappingSourceBuilder::MappingMode  mode)

Sets the functions to Get/Set the NXOpen::AME::MappingSourceBuilder::MappingMode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

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

Returns the functions to Get/Set the NXOpen::AME::MappingSourceBuilder::MappingMode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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