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

Represents a NXOpen::UserDefinedTemplate::InstantiationBuilder
To create a new instance of this class, use NXOpen::UserDefinedTemplate::Collection::CreateInstantiationBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::UserDefinedTemplate::InstantiationBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  JaUserdefinedtemplateLayerOption { JaUserdefinedtemplateLayerOptionWork, JaUserdefinedtemplateLayerOptionOriginal, JaUserdefinedtemplateLayerOptionSpecify }
 Output layer options. More...
 

Public Member Functions

bool Explosion ()
 Returns the property of whether user is allowed to explode User Defined Template instantiation
Created in NX10.0.0. More...
 
std::vector< NXOpen::Expression * > GetExpressions ()
 Returns the expressions in User Defined Template. More...
 
NXOpen::ExpressionGetMatchedExpression (NXOpen::Expression *originalExpression, bool *canBeEdited)
 Returns the matched expression of an original expression in User Defined Template. More...
 
NXOpen::NXObjectGetMatchedReference (NXOpen::NXObject *originalReference, bool *isDirectionFlipped)
 Returns the matched reference of an original reference in User Defined Template. More...
 
std::vector< NXOpen::NXObject * > GetReferences ()
 Returns the references in User Defined Template. More...
 
int LayerNumber ()
 Returns the output layer number user specify for User Defined Template instantiation
Created in NX10.0.0. More...
 
NXOpen::UserDefinedTemplate::InstantiationBuilder::JaUserdefinedtemplateLayerOption LayerOption ()
 Returns the property of output layer option of User Defined Template instantiation
Created in NX10.0.0. More...
 
NXOpen::PartLoadAuthoringPart (const NXString &authoringPartName)
 Return the authoring part of User Defined Template object. More...
 
NXOpen::PartLoadAuthoringPart (const char *authoringPartName)
 Return the authoring part of User Defined Template object. More...
 
void SetExplosion (bool explode)
 Sets the property of whether user is allowed to explode User Defined Template instantiation
Created in NX10.0.0. More...
 
void SetLayerNumber (int layerNumber)
 Sets the output layer number user specify for User Defined Template instantiation
Created in NX10.0.0. More...
 
void SetLayerOption (NXOpen::UserDefinedTemplate::InstantiationBuilder::JaUserdefinedtemplateLayerOption layerOption)
 Sets the property of output layer option of User Defined Template instantiation
Created in NX10.0.0. More...
 
void SetMatchedReference (NXOpen::NXObject *originalReference, NXOpen::NXObject *matchedReference, bool flipDirection)
 Set the matched reference of an original reference in User Defined Template
Created in NX10.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 NXOpen::UserDefinedTemplate::InstantiationBuilder
To create a new instance of this class, use NXOpen::UserDefinedTemplate::Collection::CreateInstantiationBuilder

Created in NX10.0.0.


Member Enumeration Documentation

Output layer options.

Enumerator
JaUserdefinedtemplateLayerOptionWork 

Outputs will follow the work parts layer convention.

JaUserdefinedtemplateLayerOptionOriginal 

Outputs will be in the same layer as in authoring part.

JaUserdefinedtemplateLayerOptionSpecify 

Outputs will be in user specified layer.

Member Function Documentation

bool NXOpen::UserDefinedTemplate::InstantiationBuilder::Explosion ( )

Returns the property of whether user is allowed to explode User Defined Template instantiation
Created in NX10.0.0.



License requirements : None

std::vector<NXOpen::Expression *> NXOpen::UserDefinedTemplate::InstantiationBuilder::GetExpressions ( )

Returns the expressions in User Defined Template.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Expression* NXOpen::UserDefinedTemplate::InstantiationBuilder::GetMatchedExpression ( NXOpen::Expression originalExpression,
bool *  canBeEdited 
)

Returns the matched expression of an original expression in User Defined Template.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
originalExpressionoriginal expression
canBeEditedcan be edited
NXOpen::NXObject* NXOpen::UserDefinedTemplate::InstantiationBuilder::GetMatchedReference ( NXOpen::NXObject originalReference,
bool *  isDirectionFlipped 
)

Returns the matched reference of an original reference in User Defined Template.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
originalReferenceoriginal reference
isDirectionFlippedis direction flipped
std::vector<NXOpen::NXObject *> NXOpen::UserDefinedTemplate::InstantiationBuilder::GetReferences ( )

Returns the references in User Defined Template.

Returns

Created in NX10.0.0.

License requirements : None
int NXOpen::UserDefinedTemplate::InstantiationBuilder::LayerNumber ( )

Returns the output layer number user specify for User Defined Template instantiation
Created in NX10.0.0.



License requirements : None

NXOpen::UserDefinedTemplate::InstantiationBuilder::JaUserdefinedtemplateLayerOption NXOpen::UserDefinedTemplate::InstantiationBuilder::LayerOption ( )

Returns the property of output layer option of User Defined Template instantiation
Created in NX10.0.0.



License requirements : None

NXOpen::Part* NXOpen::UserDefinedTemplate::InstantiationBuilder::LoadAuthoringPart ( const NXString authoringPartName)

Return the authoring part of User Defined Template object.

Returns

Created in NX10.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")
Parameters
authoringPartNameName of the authoring part with full path
NXOpen::Part* NXOpen::UserDefinedTemplate::InstantiationBuilder::LoadAuthoringPart ( const char *  authoringPartName)

Return the authoring part of User Defined Template object.

Returns

Created in NX10.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")
Parameters
authoringPartNameName of the authoring part with full path
void NXOpen::UserDefinedTemplate::InstantiationBuilder::SetExplosion ( bool  explode)

Sets the property of whether user is allowed to explode User Defined Template instantiation
Created in NX10.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
explodeexplode
void NXOpen::UserDefinedTemplate::InstantiationBuilder::SetLayerNumber ( int  layerNumber)

Sets the output layer number user specify for User Defined Template instantiation
Created in NX10.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
layerNumberlayer number
void NXOpen::UserDefinedTemplate::InstantiationBuilder::SetLayerOption ( NXOpen::UserDefinedTemplate::InstantiationBuilder::JaUserdefinedtemplateLayerOption  layerOption)

Sets the property of output layer option of User Defined Template instantiation
Created in NX10.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
layerOptionlayer option
void NXOpen::UserDefinedTemplate::InstantiationBuilder::SetMatchedReference ( NXOpen::NXObject originalReference,
NXOpen::NXObject matchedReference,
bool  flipDirection 
)

Set the matched reference of an original reference in User Defined Template
Created in NX10.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
originalReferenceoriginal reference
matchedReferencematched reference
flipDirectionflip direction

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