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

Represents a Symbol Variant creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolVariantBuilder

Created in NX1847.0.0. More...

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

Public Types

enum  Variant {
  VariantA, VariantB, VariantC, VariantD,
  VariantE, VariantF, VariantG, VariantH,
  VariantContactBlockInPath, VariantContactBlockOnComponent
}
 represents the type of Symbol Variant More...
 

Public Member Functions

NXString Description ()
 Returns the variant description
Created in NX1847.0.0. More...
 
bool EditMode ()
 Returns the flag for edit mode
Created in NX1847.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the variant description
Created in NX1847.0.0. More...
 
void SetDescription (const char *description)
 Sets the variant description
Created in NX1847.0.0. More...
 
void SetEditMode (bool editMode)
 Sets the flag for edit mode
Created in NX1847.0.0. More...
 
void SetSymbolVariant (NXOpen::AME::SymbolVariantBuilder::Variant symbolVariant)
 Sets the variant type
Created in NX1847.0.0. More...
 
NXOpen::AME::SymbolVariantBuilder::Variant SymbolVariant ()
 Returns the variant type
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

Represents a Symbol Variant creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolVariantBuilder

Created in NX1847.0.0.


Member Enumeration Documentation

represents the type of Symbol Variant

Enumerator
VariantA 

a

VariantB 

b

VariantC 

c

VariantD 

d

VariantE 

e

VariantF 

f

VariantG 

g

VariantH 

h

VariantContactBlockInPath 

contact block in path

VariantContactBlockOnComponent 

contact block on component

Member Function Documentation

NXString NXOpen::AME::SymbolVariantBuilder::Description ( )

Returns the variant description
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::SymbolVariantBuilder::EditMode ( )

Returns the flag for edit mode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolVariantBuilder::SetDescription ( const NXString description)

Sets the variant description
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::SymbolVariantBuilder::SetDescription ( const char *  description)

Sets the variant description
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::SymbolVariantBuilder::SetEditMode ( bool  editMode)

Sets the flag for edit mode
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
editModeeditmode
void NXOpen::AME::SymbolVariantBuilder::SetSymbolVariant ( NXOpen::AME::SymbolVariantBuilder::Variant  symbolVariant)

Sets the variant type
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolVariantsymbolvariant
NXOpen::AME::SymbolVariantBuilder::Variant NXOpen::AME::SymbolVariantBuilder::SymbolVariant ( )

Returns the variant type
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.