NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
NXOpen.PDM.VariantConfigurationBuilder Class Reference

Represents a builder class that performs variant rule configuration. More...

Inheritance diagram for NXOpen.PDM.VariantConfigurationBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void AddMultipleVariantRules (string[] contextIds, string[] variantRules)
 Adds given variant rules in case of multiple variant rules to NXOpen.PDM.VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...
 
unsafe string[] AskAvailableVariantRules (string contextId, string revId)
 Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID. More...
 
unsafe void GetVariantRuleTableInformation (out string[] contextIds, out string[] variantRules)
 Returns selected variant rules stored inside NXOpen.PDM.VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...
 
unsafe void RemoveVariantRule (string contextId, string variantRule)
 Removes the given variant rule from NXOpen.PDM.VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a builder class that performs variant rule configuration.

Created in NX9.0.0

Member Function Documentation

unsafe void NXOpen.PDM.VariantConfigurationBuilder.AddMultipleVariantRules ( string[]  contextIds,
string[]  variantRules 
)
inline

Adds given variant rules in case of multiple variant rules to NXOpen.PDM.VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
contextIdscontext id comprising of multifield key and itemRev_id in which variant rule resides
variantRulesvariant rules of corresponding context ids to be added
unsafe string [] NXOpen.PDM.VariantConfigurationBuilder.AskAvailableVariantRules ( string  contextId,
string  revId 
)
inline

Returns the saved variant rules for the give context ID The input contextId: In case of default domain: it should be Teamcenter item ID.

In case of non-default domain: it should be the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
contextIdmultifield key in case of product assembly or collaborative design id
revIditemRev_id in case of product assembly
Returns
variant rules from the given context
unsafe void NXOpen.PDM.VariantConfigurationBuilder.GetVariantRuleTableInformation ( out string[]  contextIds,
out string[]  variantRules 
)
inline

Returns selected variant rules stored inside NXOpen.PDM.VariantConfigurationBuilder The input contextIds comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
contextIdsarray of contextIds comprising of multifield key and itemRev_id from which variant rules are selected
variantRulesarray of selected variant rules
unsafe void NXOpen.PDM.VariantConfigurationBuilder.RemoveVariantRule ( string  contextId,
string  variantRule 
)
inline

Removes the given variant rule from NXOpen.PDM.VariantConfigurationBuilder if applicable The input contextId comprising of multifield key and itemRev_id: In case of default domain: contextId should contain Teamcenter item ID.

In case of non-default domain: contextId should contain the multifield keys. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Created in NX9.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters
contextIdcontext id comprising of multifield key and itemRev_id in which variant rule resides
variantRulevariant rule to be removed
unsafe bool NXOpen.PDM.VariantConfigurationBuilder.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.


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