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

Manages the value set by allowing them to be created and add new values More...

Inheritance diagram for NXOpen.AME.ValueSetBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void AddOrUpdateProductSelection (NXOpen.NXObject owningValueSet, NXOpen.AME.AMEEngObject[] inputDevices, string mainProductPart, string[] auxliaryProductParts)
 The method to add or update product selection More...
 
unsafe NXOpen.NXObject AddPropertyToValueSet (NXOpen.NXObject valueSet, NXOpen.NXObject propertyOwner, string propertyName, string propertyCategory)
 The method to allow a new property to be added to the value set More...
 
unsafe NXOpen.NXObject[] ApplyValueSetInProject (NXOpen.NXObject valueSet)
 Method to apply value set in a project environment More...
 
unsafe NXOpen.NXObject[] ApplyValueSetInTemplate (NXOpen.NXObject valueSet)
 Method to apply value set More...
 
unsafe NXOpen.NXObject CreateValueSet ()
 The method allows the value set to be created More...
 
unsafe void DeleteValueSetProperties (NXOpen.NXObject[] properties)
 Method to delete existing value set properties More...
 
unsafe void DeleteValueSetPropertyOwners (NXOpen.NXObject[] propertyOwners)
 Method to delete existing value set property owners More...
 
unsafe void DeleteValueSets (NXOpen.NXObject[] objects)
 Method to delete existing value sets More...
 
unsafe NXOpen.NXObject[] GetValueSetsInTemplate ()
 Method to get value sets in selected template More...
 
unsafe NXOpen.NXObject[] PasteValueSetObjects ()
 Pastes copied value set objects More...
 
unsafe void RemoveProductSelection (NXOpen.NXObject[] propertyOwners)
 Method to remove assigned main and auxiliary product selection from property owners More...
 
unsafe void SetAsDefault (NXOpen.NXObject valueSet)
 A method that allows the value set to be used as default for a variant More...
 
unsafe void SetValueSetName (NXOpen.NXObject valueSetObject, string newName)
 Method to set name of the value set More...
 
unsafe void SetValueSetObjectsToCopy (NXOpen.NXObject[] objects)
 Sets all value set objects to be copied 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...
 
- 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...
 

Properties

unsafe bool BreakUnLockedTemplate [get, set]
 Returns or sets the option to exchange product by breaking unlocked template More...
 
unsafe bool ExchangePLCRelevantProduct [get, set]
 Returns or sets the option to exchange PLC relevant product on applying of value set More...
 
unsafe
NXOpen.AME.SelectAMEBaseNodeList 
SelectedTemplateMembers [get]
 Returns the template instances More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Manages the value set by allowing them to be created and add new values

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateValueSetBuilder

Created in NX1872.0.0

Member Function Documentation

unsafe void NXOpen.AME.ValueSetBuilder.AddOrUpdateProductSelection ( NXOpen.NXObject  owningValueSet,
NXOpen.AME.AMEEngObject[]  inputDevices,
string  mainProductPart,
string[]  auxliaryProductParts 
)
inline

The method to add or update product selection

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
owningValueSet
inputDevices
mainProductPart
auxliaryProductParts
unsafe NXOpen.NXObject NXOpen.AME.ValueSetBuilder.AddPropertyToValueSet ( NXOpen.NXObject  valueSet,
NXOpen.NXObject  propertyOwner,
string  propertyName,
string  propertyCategory 
)
inline

The method to allow a new property to be added to the value set

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
valueSet
propertyOwner
propertyName
propertyCategory
Returns
unsafe NXOpen.NXObject [] NXOpen.AME.ValueSetBuilder.ApplyValueSetInProject ( NXOpen.NXObject  valueSet)
inline

Method to apply value set in a project environment

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
valueSet
Returns
unsafe NXOpen.NXObject [] NXOpen.AME.ValueSetBuilder.ApplyValueSetInTemplate ( NXOpen.NXObject  valueSet)
inline

Method to apply value set

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
valueSet
Returns
unsafe NXOpen.NXObject NXOpen.AME.ValueSetBuilder.CreateValueSet ( )
inline

The method allows the value set to be created

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns
unsafe void NXOpen.AME.ValueSetBuilder.DeleteValueSetProperties ( NXOpen.NXObject[]  properties)
inline

Method to delete existing value set properties

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
properties
unsafe void NXOpen.AME.ValueSetBuilder.DeleteValueSetPropertyOwners ( NXOpen.NXObject[]  propertyOwners)
inline

Method to delete existing value set property owners

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyOwners
unsafe void NXOpen.AME.ValueSetBuilder.DeleteValueSets ( NXOpen.NXObject[]  objects)
inline

Method to delete existing value sets

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objects
unsafe NXOpen.NXObject [] NXOpen.AME.ValueSetBuilder.GetValueSetsInTemplate ( )
inline

Method to get value sets in selected template

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns
unsafe NXOpen.NXObject [] NXOpen.AME.ValueSetBuilder.PasteValueSetObjects ( )
inline

Pastes copied value set objects

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns
unsafe void NXOpen.AME.ValueSetBuilder.RemoveProductSelection ( NXOpen.NXObject[]  propertyOwners)
inline

Method to remove assigned main and auxiliary product selection from property owners

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyOwners
unsafe void NXOpen.AME.ValueSetBuilder.SetAsDefault ( NXOpen.NXObject  valueSet)
inline

A method that allows the value set to be used as default for a variant

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
valueSet
unsafe void NXOpen.AME.ValueSetBuilder.SetValueSetName ( NXOpen.NXObject  valueSetObject,
string  newName 
)
inline

Method to set name of the value set

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
valueSetObject
newName
unsafe void NXOpen.AME.ValueSetBuilder.SetValueSetObjectsToCopy ( NXOpen.NXObject[]  objects)
inline

Sets all value set objects to be copied

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectsAll the value set objects to be copied

Property Documentation

unsafe bool NXOpen.AME.ValueSetBuilder.BreakUnLockedTemplate
getset

Returns or sets the option to exchange product by breaking unlocked template

Created in NX1872.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe bool NXOpen.AME.ValueSetBuilder.ExchangePLCRelevantProduct
getset

Returns or sets the option to exchange PLC relevant product on applying of value set

Created in NX1872.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectAMEBaseNodeList NXOpen.AME.ValueSetBuilder.SelectedTemplateMembers
get

Returns the template instances

Created in NX1899.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.