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

Create a extract attribute
This object does not need a creator. More...

Inheritance diagram for NXOpen::AME::ExtractAttributeRelativeBuilder:
NXOpen::AME::ExtractAttributeBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ModeValue { ModeValueSelectProperty, ModeValueManualInput }
 Choices for position to be either begin, end or defined by index. More...
 

Public Member Functions

NXString CategoryName ()
 Returns the category name given by the user
Created in NX1847.0.0. More...
 
NXOpen::ExpressionExpression ()
 Returns the expression for the relative formula
Created in NX11.0.0. More...
 
NXOpen::AME::ExtractAttributeRelativeBuilder::ModeValue Mode ()
 Returns the input mode
Created in NX1847.0.0. More...
 
NXOpen::NXObjectObjectFromExp ()
 Returns the object found by the relative formula
Created in NX11.0.0. More...
 
NXString PropertyName ()
 Returns the property name given by the user
Created in NX1847.0.0. More...
 
NXOpen::AME::SelectionBaseDefinitionBuilderSelectBaseDefinition ()
 Returns the selection base definition builder
Created in NX1847.0.0. More...
 
void SetCategoryName (const NXString &categoryName)
 Sets the category name given by the user
Created in NX1847.0.0. More...
 
void SetCategoryName (const char *categoryName)
 Sets the category name given by the user
Created in NX1847.0.0. More...
 
void SetMode (NXOpen::AME::ExtractAttributeRelativeBuilder::ModeValue modeType)
 Sets the input mode
Created in NX1847.0.0. More...
 
void SetPropertyName (const NXString &propertyName)
 Sets the property name given by the user
Created in NX1847.0.0. More...
 
void SetPropertyName (const char *propertyName)
 Sets the property name given by the user
Created in NX1847.0.0. More...
 
NXOpen::NXObjectTypeProperty ()
 Returns the object to hold the type id
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::AME::ExtractAttributeBaseBuilder
NXString Context ()
 Returns the object context
Created in NX11.0.0. More...
 
NXOpen::NXObjectContextObject ()
 Returns the context object in source object to extract the attribute from
Created in NX12.0.0. More...
 
NXString Name ()
 Returns the extracted attribute name
Created in NX11.0.0. More...
 
void SetContext (const NXString &context)
 Sets the object context
Created in NX11.0.0. More...
 
void SetContext (const char *context)
 Sets the object context
Created in NX11.0.0. More...
 
void SetContextObject (NXOpen::NXObject *contextObject)
 Sets the context object in source object to extract the attribute from
Created in NX12.0.0. More...
 
void SetName (const NXString &name)
 Sets the extracted attribute name
Created in NX11.0.0. More...
 
void SetName (const char *name)
 Sets the extracted attribute name
Created in NX11.0.0. More...
 
void SetSourceObject (NXOpen::NXObject *selection)
 Sets the object to extract the attribute from
Created in NX11.0.0. More...
 
NXOpen::NXObjectSourceObject ()
 Returns the object to extract the attribute from
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

Create a extract attribute
This object does not need a creator.



Created in NX11.0.0.

Member Enumeration Documentation

Choices for position to be either begin, end or defined by index.

Enumerator
ModeValueSelectProperty 

select property

ModeValueManualInput 

manual input

Member Function Documentation

NXString NXOpen::AME::ExtractAttributeRelativeBuilder::CategoryName ( )

Returns the category name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Expression* NXOpen::AME::ExtractAttributeRelativeBuilder::Expression ( )

Returns the expression for the relative formula
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ExtractAttributeRelativeBuilder::ModeValue NXOpen::AME::ExtractAttributeRelativeBuilder::Mode ( )

Returns the input mode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::NXObject* NXOpen::AME::ExtractAttributeRelativeBuilder::ObjectFromExp ( )

Returns the object found by the relative formula
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ExtractAttributeRelativeBuilder::PropertyName ( )

Returns the property name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionBaseDefinitionBuilder* NXOpen::AME::ExtractAttributeRelativeBuilder::SelectBaseDefinition ( )

Returns the selection base definition builder
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ExtractAttributeRelativeBuilder::SetCategoryName ( const NXString categoryName)

Sets the category name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
categoryNamecategoryname
void NXOpen::AME::ExtractAttributeRelativeBuilder::SetCategoryName ( const char *  categoryName)

Sets the category name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
categoryNamecategoryname
void NXOpen::AME::ExtractAttributeRelativeBuilder::SetMode ( NXOpen::AME::ExtractAttributeRelativeBuilder::ModeValue  modeType)

Sets the input mode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
modeTypemodetype
void NXOpen::AME::ExtractAttributeRelativeBuilder::SetPropertyName ( const NXString propertyName)

Sets the property name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname
void NXOpen::AME::ExtractAttributeRelativeBuilder::SetPropertyName ( const char *  propertyName)

Sets the property name given by the user
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname
NXOpen::NXObject* NXOpen::AME::ExtractAttributeRelativeBuilder::TypeProperty ( )

Returns the object to hold the type id
Created in NX11.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.