Class SubsetRecipe

Inheritance

System.Object

System.MarshalByRefObject

NXRemotableObject

TaggedObjectCollection

SubsetRecipe

Implements

System.Runtime.Remoting.Messaging.IMessageSink

System.Collections.IEnumerable

Inherited Members

TaggedObjectCollection.GetEnumerator()

TaggedObjectCollection.initialize()

NXRemotableObject.SyncProcessMessage(IMessage)

NXRemotableObject.AsyncProcessMessage(IMessage, IMessageSink)

NXRemotableObject.NextSink

System.MarshalByRefObject.CreateObjRef(System.Type)

System.MarshalByRefObject.GetLifetimeService()

System.MarshalByRefObject.InitializeLifetimeService()

System.MarshalByRefObject.MemberwiseClone(System.Boolean)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NXOpen.Assemblies

Assembly: NXOpen.dll

Syntax

public class SubsetRecipe : TaggedObjectCollection, IMessageSink, IEnumerable

Constructors

SubsetRecipe()

Declaration

protected SubsetRecipe()

SubsetRecipe(SubsetBuilder)

Declaration

protected SubsetRecipe(SubsetBuilder owner)

Parameters

Type	Name	Description
SubsetBuilder	owner

Properties

Tag

Declaration

public Tag Tag { get; }

Property Value

Type	Description
Tag

Methods

AddSearchTermBuilder(SearchTermBuilder)

Declaration

public void AddSearchTermBuilder(SearchTermBuilder searchTermBuilder)

Parameters

Type	Name	Description
SearchTermBuilder	searchTermBuilder

CreateAttributeSearchTerm(SearchTerm.SearchTermLogicType, String, String[], String[])

Declaration

public AttributeSearchTerm CreateAttributeSearchTerm(SearchTerm.SearchTermLogicType logicType, string queryName, string[] entries, string[] values)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
System.String	queryName
System.String[]	entries
System.String[]	values

Returns

Type	Description
AttributeSearchTerm

CreateBoxSearchTerm(SearchTerm.SearchTermLogicType, BoxSearchTerm.BoxOverlapLogicType, Point3d, Point3d, Boolean)

Declaration

public BoxSearchTerm CreateBoxSearchTerm(SearchTerm.SearchTermLogicType logicType, BoxSearchTerm.BoxOverlapLogicType overlapType, Point3d bottomCorner, Point3d topCorner, bool trueShapeRefinement)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
BoxSearchTerm.BoxOverlapLogicType	overlapType
Point3d	bottomCorner
Point3d	topCorner
System.Boolean	trueShapeRefinement

Returns

Type	Description
BoxSearchTerm

CreateExplicitSearchTerm(SearchTerm.SearchTermLogicType, SearchResultElement)

Declaration

public ExplicitSearchTerm CreateExplicitSearchTerm(SearchTerm.SearchTermLogicType logicType, SearchResultElement searchResultElement)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
SearchResultElement	searchResultElement

Returns

Type	Description
ExplicitSearchTerm

CreateExplicitSearchTermGroup(SearchTerm.SearchTermLogicType, SearchResultElement[])

Declaration

public GroupSearchTerm CreateExplicitSearchTermGroup(SearchTerm.SearchTermLogicType logicType, SearchResultElement[] searchResultElements)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
SearchResultElement[]	searchResultElements

Returns

Type	Description
GroupSearchTerm

CreatePartitionSearchTerm(SearchTerm.SearchTermLogicType, Partition)

Declaration

[Obsolete("Deprecated in NX11.0.0.  Use the NXOpen.Assemblies.SubsetRecipe.CreatePartitionSearchTerm that gives specific control on whether or not to include children partition as well")]
public PartitionSearchTerm CreatePartitionSearchTerm(SearchTerm.SearchTermLogicType logicType, Partition partition)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
Partition	partition

Returns

Type	Description
PartitionSearchTerm

CreatePartitionSearchTerm(SearchTerm.SearchTermLogicType, PartitionSearchTerm.IncludeChildren, Partition)

Declaration

public PartitionSearchTerm CreatePartitionSearchTerm(SearchTerm.SearchTermLogicType logicType, PartitionSearchTerm.IncludeChildren includeChildrenLogic, Partition partition)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
PartitionSearchTerm.IncludeChildren	includeChildrenLogic
Partition	partition

Returns

Type	Description
PartitionSearchTerm

CreatePartitionSearchTermGroup(SearchTerm.SearchTermLogicType, Partition[])

Declaration

[Obsolete("Deprecated in NX11.0.0.  Use the NXOpen.Assemblies.SubsetRecipe.CreatePartitionSearchTermGroup that gives specific control on whether or not to include children partition as well")]
public GroupSearchTerm CreatePartitionSearchTermGroup(SearchTerm.SearchTermLogicType logicType, Partition[] partitions)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
Partition[]	partitions

Returns

Type	Description
GroupSearchTerm

CreatePartitionSearchTermGroup(SearchTerm.SearchTermLogicType, PartitionSearchTerm.IncludeChildren, Partition[])

Declaration

public GroupSearchTerm CreatePartitionSearchTermGroup(SearchTerm.SearchTermLogicType logicType, PartitionSearchTerm.IncludeChildren includeChildrenLogic, Partition[] partitions)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
PartitionSearchTerm.IncludeChildren	includeChildrenLogic
Partition[]	partitions

Returns

Type	Description
GroupSearchTerm

CreatePlaneSearchTerm(SearchTerm.SearchTermLogicType, PlaneSearchTerm.PlaneOverlapLogicType, Vector3d, Double, Point3d, Boolean)

Declaration

public PlaneSearchTerm CreatePlaneSearchTerm(SearchTerm.SearchTermLogicType logicType, PlaneSearchTerm.PlaneOverlapLogicType overlapType, Vector3d normal, double displacement, Point3d pointOnPlane, bool trueShapeRefinement)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
PlaneSearchTerm.PlaneOverlapLogicType	overlapType
Vector3d	normal
System.Double	displacement
Point3d	pointOnPlane
System.Boolean	trueShapeRefinement

Returns

Type	Description
PlaneSearchTerm

CreateProximitySearchTerm(SearchTerm.SearchTermLogicType, SearchResultElement[], Double, Boolean)

Declaration

public ProximitySearchTerm CreateProximitySearchTerm(SearchTerm.SearchTermLogicType logicType, SearchResultElement[] seeds, double distance, bool trueShapeRefinement)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
SearchResultElement[]	seeds
System.Double	distance
System.Boolean	trueShapeRefinement

Returns

Type	Description
ProximitySearchTerm

CreateRunContentProximitySearchTerm(SearchTerm.SearchTermLogicType, String, Double, Boolean)

Declaration

public RunContentProximitySearchTerm CreateRunContentProximitySearchTerm(SearchTerm.SearchTermLogicType logicType, string seedRunName, double distance, bool trueShapeRefinement)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
System.String	seedRunName
System.Double	distance
System.Boolean	trueShapeRefinement

Returns

Type	Description
RunContentProximitySearchTerm

DeleteSearchTerms(SearchTerm[])

Declaration

public void DeleteSearchTerms(SearchTerm[] searchTerms)

Parameters

Type	Name	Description
SearchTerm[]	searchTerms

EnumerateMoveNext(ref Tag, Byte[])

Declaration

protected override int EnumerateMoveNext(ref Tag currentTag, byte[] state)

Parameters

Type	Name	Description
Tag	currentTag
System.Byte[]	state

Returns

Type	Description
System.Int32

Overrides

TaggedObjectCollection.EnumerateMoveNext(ref Tag, Byte[])

FindObject(String)

Declaration

public SearchTerm FindObject(string journalIdentifier)

Parameters

Type	Name	Description
System.String	journalIdentifier

Returns

Type	Description
SearchTerm

GetAllSearchOptions(String)

Declaration

public string[] GetAllSearchOptions(string optionSet)

Parameters

Type	Name	Description
System.String	optionSet

Returns

Type	Description
System.String[]

GetAllSearchOptionSets()

Declaration

public string[] GetAllSearchOptionSets()

Returns

Type	Description
System.String[]

GetSearchOptionValue(String, String)

Declaration

public bool GetSearchOptionValue(string optionSet, string searchOption)

Parameters

Type	Name	Description
System.String	optionSet
System.String	searchOption

Returns

Type	Description
System.Boolean

Group(SearchTerm.SearchTermLogicType, SearchTerm[])

Declaration

public void Group(SearchTerm.SearchTermLogicType logicType, SearchTerm[] searchTerms)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
SearchTerm[]	searchTerms

MoveDown(SearchTerm)

Declaration

public void MoveDown(SearchTerm searchTerm)

Parameters

Type	Name	Description
SearchTerm	searchTerm

MoveUp(SearchTerm)

Declaration

public void MoveUp(SearchTerm searchTerm)

Parameters

Type	Name	Description
SearchTerm	searchTerm

SetPartitionSearchTermLogic(SearchTerm.SearchTermLogicType, PartitionSearchTerm.IncludeChildren, SearchTerm[])

Declaration

public void SetPartitionSearchTermLogic(SearchTerm.SearchTermLogicType logicType, PartitionSearchTerm.IncludeChildren includeChildrenLogic, SearchTerm[] searchTerms)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
PartitionSearchTerm.IncludeChildren	includeChildrenLogic
SearchTerm[]	searchTerms

SetSearchOptionValue(String, String, Boolean)

Declaration

public void SetSearchOptionValue(string optionSet, string searchOption, bool optionValue)

Parameters

Type	Name	Description
System.String	optionSet
System.String	searchOption
System.Boolean	optionValue

SetSearchTermLogic(SearchTerm.SearchTermLogicType, SearchTerm[])

Declaration

public void SetSearchTermLogic(SearchTerm.SearchTermLogicType logicType, SearchTerm[] searchTerms)

Parameters

Type	Name	Description
SearchTerm.SearchTermLogicType	logicType
SearchTerm[]	searchTerms

ToArray()

Declaration

public SearchTerm[] ToArray()

Returns

Type	Description
SearchTerm[]

Ungroup(SearchTerm[])

Declaration

public void Ungroup(SearchTerm[] searchTerms)

Parameters

Type	Name	Description
SearchTerm[]	searchTerms

Implements

System.Runtime.Remoting.Messaging.IMessageSink

System.Collections.IEnumerable