Builder class for Bulk Replacement which manages replacement operations on Routing objects More...

Inheritance diagram for NXOpen.Routing.BulkReplacementBuilder:

Public Member Functions
unsafe void	ClearAttributeForAllObjects (NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The attribute value clear method for all objects More...

unsafe void	ClearAttributeForObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The object attribute value clear method More...

unsafe void	CopySearchResultsToObject (NXOpen.NXObject fromObjectTag, NXOpen.NXObject toObjectTag)
	The method that copies the search results from one object to another More...

unsafe string	GetAttributeForObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The object attribute value method getter More...

unsafe int	GetPartLayer ()
	The method that gets the layer used for newly replaced objects More...

unsafe string[]	GetPartLibraryValuesForAttributeForObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The method gets the part libray values for a given attribute for the specified object More...

unsafe string	GetPartReferenceSet ()
	The method that gets the reference set used for newly replaced objects More...

unsafe NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType	GetReplacementMethodForObject (NXOpen.NXObject objectTag)
	The replacement method getter More...

unsafe string	GetReplacementObjectIdentifierForObject (NXOpen.NXObject objectTag)
	The replacement object identifier getter More...

unsafe string[]	GetReplacementObjectIdentifiersFromSearchResultsForObject (NXOpen.NXObject objectTag)
	The possible replacement object identifiers method getter More...

unsafe NXOpen.Routing.RoutingBulkReplacementBuilderRetainReasonType	GetRetainReasonForObject (NXOpen.NXObject objectTag)
	The retain reason getter More...

unsafe string[]	GetSelectedObjectValuesForAttribute (NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The method that retrieves all the values for a given attribute from all the objects More...

unsafe string	GetValueForAttributeFromReferenceObject (NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The method that returns the value of an attribute from the reference object More...

unsafe void	SearchForReplacementForObject (NXOpen.NXObject objectTag)
	The method that initiates a search for the replacement object More...

unsafe void	SearchForReplacementForObjectOnAttributes (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType[] attributeIdTypes, string[] attributeIds)
	The method that initiates a search for the replacement object using on the passed in attributes as criteria More...

unsafe void	SetAttributeForAllObjects (NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId, string value)
	The attribute value setter for all objects More...

unsafe void	SetAttributeForObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId, string value)
	The object attribute value method setter More...

unsafe void	SetAttributeValueForObjectFromReferenceObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingAttributeIdentifierType attributeIdType, string attributeId)
	The method that sets the attribute value from the reference object on the specifiec object More...

unsafe void	SetPartLayer (int layer)
	The method that sets the layer used for newly replaced objects More...

unsafe void	SetPartReferenceSet (string referenceSetName)
	The method that sets the reference set used for newly replaced objects More...

unsafe void	SetReplacementClassificationObjectForObject (NXOpen.NXObject objectTag, string classificationClassId, string classificationInstanceId)
	The replacement object method setter More...

unsafe void	SetReplacementMethodForAllObjects (NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType method)
	The replacement method setter for all objects More...

unsafe void	SetReplacementMethodForObject (NXOpen.NXObject objectTag, NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType method)
	The replacement method setter More...

unsafe void	SetReplacementObjectIdentifierForObject (NXOpen.NXObject objectTag, string objectIdentifier)
	The replacement object identifier method setter More...

unsafe void	SetReplacementObjectPartNumberForObject (NXOpen.NXObject objectTag, string partNumber)
	The replacement object part number method setter More...

unsafe void	SetReplacementPartSpecificationForObject (NXOpen.NXObject objectTag, string partSpecification)
	The replacement part specification method setter More...

unsafe void	SetSequenceOfObjectReplacement (NXOpen.NXObject[] objects)
	The method that sets the sequence of object replacement 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 NXOpen.SelectNXObject	ReferenceObject `[get]`
	Returns the reference object used to extract characteristics for Bulk Replacement More...

unsafe NXOpen.Routing.RouteObjectCollector	RouteObjectCollector `[get]`
	Returns the Routing object collector 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

Builder class for Bulk Replacement which manages replacement operations on Routing objects

Not support KF.

Created in NX12.0.0

Member Function Documentation

unsafe void NXOpen.Routing.BulkReplacementBuilder.ClearAttributeForAllObjects	(	NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The attribute value clear method for all objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

attributeIdType	The type of attribute being cleared
attributeId	The identifier of the attribute value being cleared

unsafe void NXOpen.Routing.BulkReplacementBuilder.ClearAttributeForObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The object attribute value clear method

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to clear the attribute value
attributeIdType	The type of attribute being cleared
attributeId	The identifier of the attribute value being cleared

unsafe void NXOpen.Routing.BulkReplacementBuilder.CopySearchResultsToObject	(	NXOpen.NXObject	fromObjectTag,
		NXOpen.NXObject	toObjectTag
	)

inline

The method that copies the search results from one object to another

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

fromObjectTag	The object from which you want to copy the search results
toObjectTag	The object to which you want to copy the search results

unsafe string NXOpen.Routing.BulkReplacementBuilder.GetAttributeForObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The object attribute value method getter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to get the attribute value
attributeIdType	The type of attribute being retrieved
attributeId	The identifier of the attribute value being retrieved

Returns: The value of the attribute

unsafe int NXOpen.Routing.BulkReplacementBuilder.GetPartLayer ( )

inline

The method that gets the layer used for newly replaced objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Returns: The number of the layer

unsafe string [] NXOpen.Routing.BulkReplacementBuilder.GetPartLibraryValuesForAttributeForObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The method gets the part libray values for a given attribute for the specified object

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to get the part library values
attributeIdType	The type of attribute for which to get the values
attributeId	The identifier of the attribute for which to get the values

Returns: The values retrieved from all the part library for the attribute

unsafe string NXOpen.Routing.BulkReplacementBuilder.GetPartReferenceSet ( )

inline

The method that gets the reference set used for newly replaced objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Returns: The name of the reference set

unsafe NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType NXOpen.Routing.BulkReplacementBuilder.GetReplacementMethodForObject ( NXOpen.NXObject objectTag )

inline

The replacement method getter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag The object for which to get the replacement method

Returns: The replacement method currently set for this object

unsafe string NXOpen.Routing.BulkReplacementBuilder.GetReplacementObjectIdentifierForObject ( NXOpen.NXObject objectTag )

inline

The replacement object identifier getter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag The object for which to get the replacement object

Returns: The object identifier for which is currently set as the replacement object

unsafe string [] NXOpen.Routing.BulkReplacementBuilder.GetReplacementObjectIdentifiersFromSearchResultsForObject ( NXOpen.NXObject objectTag )

inline

The possible replacement object identifiers method getter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag The object for which to get the possible replacement object identifiers

Returns: array of object identifiers which are possible replacement objects

unsafe NXOpen.Routing.RoutingBulkReplacementBuilderRetainReasonType NXOpen.Routing.BulkReplacementBuilder.GetRetainReasonForObject ( NXOpen.NXObject objectTag )

inline

The retain reason getter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag The object for which to get the retain reason

Returns: The retain reason currently set for this object

unsafe string [] NXOpen.Routing.BulkReplacementBuilder.GetSelectedObjectValuesForAttribute	(	NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The method that retrieves all the values for a given attribute from all the objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

attributeIdType	The type of attribute for which to get all the values
attributeId	The identifier of the attribute for which to get all the values

Returns: The values retrieved from all the objects for the attribute

unsafe string NXOpen.Routing.BulkReplacementBuilder.GetValueForAttributeFromReferenceObject	(	NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The method that returns the value of an attribute from the reference object

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

attributeIdType	The type of attribute for which to get the value
attributeId	The identifier of the attribute for which to get all the values

Returns: The value of the attribute from the reference object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SearchForReplacementForObject ( NXOpen.NXObject objectTag )

inline

The method that initiates a search for the replacement object

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag The object for which to initiate the search

unsafe void NXOpen.Routing.BulkReplacementBuilder.SearchForReplacementForObjectOnAttributes	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType[]	attributeIdTypes,
		string[]	attributeIds
	)

inline

The method that initiates a search for the replacement object using on the passed in attributes as criteria

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to initiate the search
attributeIdTypes	The array of attribute types to limit the search
attributeIds	The array of attribute identifiers to limit the search

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetAttributeForAllObjects	(	NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId,
		string	value
	)

inline

The attribute value setter for all objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

attributeIdType	The type of attribute value being set
attributeId	The identifier of the attribute value being set
value	The new value for the attribute

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetAttributeForObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId,
		string	value
	)

inline

The object attribute value method setter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the attribute value
attributeIdType	The type of attribute being set
attributeId	The identifier of the attribute being set
value	The new value for the attribute

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetAttributeValueForObjectFromReferenceObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingAttributeIdentifierType	attributeIdType,
		string	attributeId
	)

inline

The method that sets the attribute value from the reference object on the specifiec object

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the attribute value from the reference object
attributeIdType	The type of attribute for which to set the value from the reference object
attributeId	The identifier of the attribute for which to set the value from the reference object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetPartLayer ( int layer )

inline

The method that sets the layer used for newly replaced objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

layer The number of the layer

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetPartReferenceSet ( string referenceSetName )

inline

The method that sets the reference set used for newly replaced objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

referenceSetName The name of the reference set

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementClassificationObjectForObject	(	NXOpen.NXObject	objectTag,
		string	classificationClassId,
		string	classificationInstanceId
	)

inline

The replacement object method setter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the replacement object
classificationClassId	The classification object class id of the object to to set as the replacement object
classificationInstanceId	The classification object instance id of the object to to set as the replacement object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementMethodForAllObjects ( NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType method )

inline

The replacement method setter for all objects

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

method The replacement method to set for all objects

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementMethodForObject	(	NXOpen.NXObject	objectTag,
		NXOpen.Routing.RoutingBulkReplacementBuilderReplacementMethodType	method
	)

inline

The replacement method setter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the replacement method
method	The replacement method to use for replacement of this object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementObjectIdentifierForObject	(	NXOpen.NXObject	objectTag,
		string	objectIdentifier
	)

inline

The replacement object identifier method setter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the replacement object
objectIdentifier	The object identifier for which to set as the replacement object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementObjectPartNumberForObject	(	NXOpen.NXObject	objectTag,
		string	partNumber
	)

inline

The replacement object part number method setter

Created in NX1899.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the replacement object
partNumber	The part numberof the object to to set as the replacement object

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetReplacementPartSpecificationForObject	(	NXOpen.NXObject	objectTag,
		string	partSpecification
	)

inline

The replacement part specification method setter

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objectTag	The object for which to set the replacement object
partSpecification	The full part specification of the part to use for replacement

unsafe void NXOpen.Routing.BulkReplacementBuilder.SetSequenceOfObjectReplacement ( NXOpen.NXObject[] objects )

inline

The method that sets the sequence of object replacement

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

Parameters

objects The objects in the order of them to be replaced

Property Documentation

unsafe NXOpen.SelectNXObject NXOpen.Routing.BulkReplacementBuilder.ReferenceObject

get

Returns the reference object used to extract characteristics for Bulk Replacement

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

unsafe NXOpen.Routing.RouteObjectCollector NXOpen.Routing.BulkReplacementBuilder.RouteObjectCollector

get

Returns the Routing object collector

Created in NX12.0.0

License requirements: routing_advanced ("Routing Advanced")

The documentation for this class was generated from the following file:

Routing_BulkReplacementBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation