NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.InterpartExpressionsBuilder Class Reference

This class creates interpart expressions from the source part to the current work part via the naming rule defined. More...

Inheritance diagram for NXOpen.InterpartExpressionsBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  NamingRules { AddPrefix, AddSuffix, Replace, RenameWithIndex }
 This defines the naming rule used for the name of the expression created in the current work part. More...
 

Public Member Functions

unsafe void GetExpressions (out NXOpen.Expression[] sourceExpressions, out string[] destinationNames)
 Get an array of source expressions. More...
 
unsafe void SetExpressions (NXOpen.Expression[] sourceExpressions, string[] destinationNames)
 Set an array of source expressions. More...
 
unsafe void SetExpressionsFor4gd (NXOpen.Assemblies.Component targetPartOcc, NXOpen.Assemblies.Component sourcePartOcc, NXOpen.Expression[] sourceExpressions, string[] destinationNames)
 Interface for 4gd More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe string BaseString [get, set]
 Returns or sets the base string. More...
 
unsafe
NXOpen.InterpartExpressionsBuilder.NamingRules 
NamingRule [get, set]
 Returns or sets the naming rule. More...
 
unsafe string ReplaceString [get, set]
 Returns or sets the replace string. More...
 

Detailed Description

This class creates interpart expressions from the source part to the current work part via the naming rule defined.

To create a new instance of this class, use NXOpen.ExpressionCollection.CreateInterpartExpressionsBuilder

Default values.

Property Value

NamingRule

AddPrefix

Created in NX8.5.0

Member Enumeration Documentation

This defines the naming rule used for the name of the expression created in the current work part.

For example, if expression "x" is selected from source part "A" then you will get these expressions below created in the current work part for the following naming rules:

yx="A"x for AddPrifix with BaseString "y" xy="A"x for AddSuffix with BaseString "y" zz="A"x for Replace with BaseString "x" and ReplaceString "zz" y0="A"x for RenameWithIndex with BaseString "y"

Empty strings are also supported for the BaseString and ReplaceString.

Errors will be issued whenever a generated left hand side expression name has incorrect syntax, already exists in the current work part or the source expression is from the current work part.

Enumerator
AddPrefix 
AddSuffix 
Replace 
RenameWithIndex 

Member Function Documentation

unsafe void NXOpen.InterpartExpressionsBuilder.GetExpressions ( out NXOpen.Expression[]  sourceExpressions,
out string[]  destinationNames 
)

Get an array of source expressions.

These are the source expressions to be referenced by the current work part. The destination names can be used to override the naming rule for a given source expression. This is a parallel array. Each source expression has an entry in this array for its destination name. If the associated destination name is the empty string then the naming rule will be used to generate the destination name for a given source expression otherwise the destination name itself will be used to name the new expression in the current work part.

Created in NX8.5.0

License requirements: None.

Parameters
sourceExpressionsarray of source expressions
destinationNamesarray of destination names
unsafe void NXOpen.InterpartExpressionsBuilder.SetExpressions ( NXOpen.Expression[]  sourceExpressions,
string[]  destinationNames 
)

Set an array of source expressions.

These are the source expressions to be referenced by the current work part. The destination names can be used to override the naming rule for a given source expression. This is a parallel array. Each source expression has an entry in this array for its destination name. If the associated destination name is the empty string then the naming rule will be used to generate the destination name for a given source expression otherwise the destination name itself will be used to name the new expression in the current work part.

Created in NX8.5.0

License requirements: None.

Parameters
sourceExpressionsarray of source expressions
destinationNamesarray of destination names
unsafe void NXOpen.InterpartExpressionsBuilder.SetExpressionsFor4gd ( NXOpen.Assemblies.Component  targetPartOcc,
NXOpen.Assemblies.Component  sourcePartOcc,
NXOpen.Expression[]  sourceExpressions,
string[]  destinationNames 
)

Interface for 4gd

Created in NX11.0.0

License requirements: None.

Parameters
targetPartOccTarget part occurrence
sourcePartOccSource part occurrence
sourceExpressionsarray of source expressions
destinationNamesarray of destination names

Property Documentation

unsafe string NXOpen.InterpartExpressionsBuilder.BaseString
getset

Returns or sets the base string.

This string is used as the prefix for AddPrefix, the suffix for AddSuffix, the replaced string for Replace and the rename string for RenameWithIndex.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.InterpartExpressionsBuilder.NamingRules NXOpen.InterpartExpressionsBuilder.NamingRule
getset

Returns or sets the naming rule.

This determines how the name of the expression in the current work part is constructed.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.InterpartExpressionsBuilder.ReplaceString
getset

Returns or sets the replace string.

This string replaces the BaseString for the Replace.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.


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