Represents a NXOpen.CAE.HotspotRecipeBuilder More...

Inheritance diagram for NXOpen.CAE.HotspotRecipeBuilder:

Classes
struct	_UnitValue
	Hotspot value structure to specify values

struct	UnitValue
	Hotspot value structure to specify values More...

Public Types
enum	EnumOffsetTypeMinMax { ByValueOffset, ByPercentageOffset, ByNumberofEntities }
	Sort min-max methods with following types More...

enum	EnumSortingMethod { Threshold, Range, MinimumResult, MaximumResults }
	Sorting methods More...

enum	EnumThresholdType { MaxOffset, MinOffset, MaxFactor, MinFactor }
	Threshold Type More...

Public Member Functions
unsafe NXOpen.TaggedObject[]	GetEntityObjects ()
	Gets the entity objects for extracting result data. More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue	GetNeighbourOffset ()
	Gets the offset to seed value More...

unsafe double	GetOffsetForMinMax ()
	Gets the offset for sorting min/max params More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue	GetOffsetValueForMinMax ()
	Gets the value offset for searching to min/max sorting method More...

unsafe string	GetResultQuantity ()
	Gets the enum result type More...

unsafe NXOpen.CAE.Result.Quantity	GetResultQuantityType ()
	Gets Result Quantity type. More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue	GetSortAboveParamVal ()
	Gets the entity value above which entity searched for hotspot More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue	GetSortBelowParamVal ()
	Gets the entity value below which entity searched for hotspot More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue	GetThresholdValue ()
	Gets the seed value of seed entity More...

unsafe void	InitFromRecipe (NXOpen.CAE.HotspotRecipe recipe)
	Init the builder from recipe More...

unsafe void	SetEntityObjects (NXOpen.TaggedObject[] entityObjs)
	Sets the entity objects for extracting result data. More...

unsafe void	SetNeighbourOffset (NXOpen.CAE.HotspotRecipeBuilder.UnitValue neighbourvalue)
	Sets the offset to seed value More...

unsafe void	SetOffsetForMinMax (double offsetByValue)
	Sets the offset for sorting min/max params More...

unsafe void	SetOffsetValueForMinMax (NXOpen.CAE.HotspotRecipeBuilder.UnitValue offsetValue)
	Sets the value offset for searching to min/max sorting method More...

unsafe void	SetResultQuantity (string resultQuantity)
	Sets the enum result type More...

unsafe void	SetResultQuantityType (NXOpen.CAE.Result.Quantity resQuan)
	Sets Result Quantity Type. More...

unsafe void	SetSortAboveParamVal (NXOpen.CAE.HotspotRecipeBuilder.UnitValue aboveValue)
	Sets the entity value above which entity searched for hotspot More...

unsafe void	SetSortBelowParamVal (NXOpen.CAE.HotspotRecipeBuilder.UnitValue belowValue)
	Sets the entity value below which entity searched for hotspot More...

unsafe void	SetThresholdValue (NXOpen.CAE.HotspotRecipeBuilder.UnitValue seedValue)
	Sets the seed value of seed entity 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.CAE.Result.DataType	DataTypeFilter `[get, set]`
	Returns or sets the e data type filter More...

unsafe bool	IsSortRangeAboveRes `[get, set]`
	Returns or sets the toggle sort above More...

unsafe bool	IsSortRangeBelowRes `[get, set]`
	Returns or sets the toggle sort below More...

unsafe bool	IsSortSelectedEntities `[get, set]`
	Returns or sets the toggle select entities More...

unsafe int	MaxNumRegions `[get, set]`
	Returns or sets the i max regions More...

unsafe int	MinSpanOfRegion `[get, set]`
	Returns or sets the min span region More...

unsafe double	NeighborOffset `[get, set]`
	Returns or sets the i neighbor offset More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumOffsetTypeMinMax	OffsetTypeMinMax `[get, set]`
	Returns or sets the enum sort min max res by More...

unsafe string	RecipeName `[get, set]`
	Returns or sets the name str More...

unsafe NXOpen.CAE.Result.Component	ResultComponent `[get, set]`
	Returns or sets the enum res comp More...

unsafe NXOpen.CAE.Result.Location	ResultLocation `[get, set]`
	Returns or sets the enum result loc More...

unsafe double	SortAboveParamVal `[get, set]`
	Returns or sets the d sort above More...

unsafe double	SortBelowParamVal `[get, set]`
	Returns or sets the d sort below More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumSortingMethod	SortMethod `[get, set]`
	Returns or sets the enum sort method More...

unsafe int	SpanOfRegion `[get, set]`
	Returns or sets the i span region More...

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumThresholdType	ThresholdType `[get, set]`
	Returns or sets the enum threshold type More...

unsafe double	ThresholdValue `[get, set]`
	Returns or sets the d threshold val 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

Represents a NXOpen.CAE.HotspotRecipeBuilder

To create a new instance of this class, use NXOpen.CAE.ResultManager.CreateHotspotRecipeBuilder

Default values.

Property

Value

IsSortRangeAboveRes

0

IsSortRangeBelowRes

0

IsSortSelectedEntities

0

MaxNumRegions

10

NeighborOffset (deprecated)

0

OffsetTypeMinMax

ByValueOffset

SortAboveParamVal (deprecated)

0

SortBelowParamVal (deprecated)

0

SpanOfRegion

0

ThresholdValue (deprecated)

0

Created in NX1872.0.0

Member Enumeration Documentation

enum NXOpen.CAE.HotspotRecipeBuilder.EnumOffsetTypeMinMax

Sort min-max methods with following types

Enumerator
ByValueOffset
ByPercentageOffset
ByNumberofEntities

enum NXOpen.CAE.HotspotRecipeBuilder.EnumSortingMethod

Sorting methods

Enumerator
Threshold
Range
MinimumResult
MaximumResults

enum NXOpen.CAE.HotspotRecipeBuilder.EnumThresholdType

Threshold Type

Enumerator
MaxOffset
MinOffset
MaxFactor
MinFactor

Member Function Documentation

unsafe NXOpen.TaggedObject [] NXOpen.CAE.HotspotRecipeBuilder.GetEntityObjects ( )

inline

Gets the entity objects for extracting result data.

Objects passed to this method are of the type defined by JA_SFRES_Location.

Created in NX1872.0.0

License requirements: None.

Returns

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue NXOpen.CAE.HotspotRecipeBuilder.GetNeighbourOffset ( )

inline

Gets the offset to seed value

Created in NX1899.0.0

License requirements: None.

Returns

unsafe double NXOpen.CAE.HotspotRecipeBuilder.GetOffsetForMinMax ( )

inline

Gets the offset for sorting min/max params

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.GetOffsetValueForMinMax instead.

License requirements: None.

Returns

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue NXOpen.CAE.HotspotRecipeBuilder.GetOffsetValueForMinMax ( )

inline

Gets the value offset for searching to min/max sorting method

Created in NX1899.0.0

License requirements: None.

Returns

unsafe string NXOpen.CAE.HotspotRecipeBuilder.GetResultQuantity ( )

inline

Gets the enum result type

Created in NX1872.0.0

License requirements: None.

Returns

unsafe NXOpen.CAE.Result.Quantity NXOpen.CAE.HotspotRecipeBuilder.GetResultQuantityType ( )

inline

Gets Result Quantity type.

Created in NX1872.0.0

License requirements: None.

Returns

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue NXOpen.CAE.HotspotRecipeBuilder.GetSortAboveParamVal ( )

inline

Gets the entity value above which entity searched for hotspot

Created in NX1899.0.0

License requirements: None.

Returns

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue NXOpen.CAE.HotspotRecipeBuilder.GetSortBelowParamVal ( )

inline

Gets the entity value below which entity searched for hotspot

Created in NX1899.0.0

License requirements: None.

Returns

unsafe NXOpen.CAE.HotspotRecipeBuilder.UnitValue NXOpen.CAE.HotspotRecipeBuilder.GetThresholdValue ( )

inline

Gets the seed value of seed entity

Created in NX1899.0.0

License requirements: None.

Returns

unsafe void NXOpen.CAE.HotspotRecipeBuilder.InitFromRecipe ( NXOpen.CAE.HotspotRecipe recipe )

inline

Init the builder from recipe

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

recipe

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetEntityObjects ( NXOpen.TaggedObject[] entityObjs )

inline

Sets the entity objects for extracting result data.

Objects passed to this method are of the type defined by JA_SFRES_Location.

Created in NX1872.0.0

License requirements: None.

Parameters

entityObjs

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetNeighbourOffset ( NXOpen.CAE.HotspotRecipeBuilder.UnitValue neighbourvalue )

inline

Sets the offset to seed value

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

neighbourvalue

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetOffsetForMinMax ( double offsetByValue )

inline

Sets the offset for sorting min/max params

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.SetOffsetValueForMinMax instead.

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

offsetByValue

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetOffsetValueForMinMax ( NXOpen.CAE.HotspotRecipeBuilder.UnitValue offsetValue )

inline

Sets the value offset for searching to min/max sorting method

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

offsetValue

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetResultQuantity ( string resultQuantity )

inline

Sets the enum result type

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

resultQuantity

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetResultQuantityType ( NXOpen.CAE.Result.Quantity resQuan )

inline

Sets Result Quantity Type.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

resQuan

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetSortAboveParamVal ( NXOpen.CAE.HotspotRecipeBuilder.UnitValue aboveValue )

inline

Sets the entity value above which entity searched for hotspot

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

aboveValue

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetSortBelowParamVal ( NXOpen.CAE.HotspotRecipeBuilder.UnitValue belowValue )

inline

Sets the entity value below which entity searched for hotspot

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

belowValue

unsafe void NXOpen.CAE.HotspotRecipeBuilder.SetThresholdValue ( NXOpen.CAE.HotspotRecipeBuilder.UnitValue seedValue )

inline

Sets the seed value of seed entity

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

seedValue

Property Documentation

unsafe NXOpen.CAE.Result.DataType NXOpen.CAE.HotspotRecipeBuilder.DataTypeFilter

getset

Returns or sets the e data type filter

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe bool NXOpen.CAE.HotspotRecipeBuilder.IsSortRangeAboveRes

getset

Returns or sets the toggle sort above

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe bool NXOpen.CAE.HotspotRecipeBuilder.IsSortRangeBelowRes

getset

Returns or sets the toggle sort below

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe bool NXOpen.CAE.HotspotRecipeBuilder.IsSortSelectedEntities

getset

Returns or sets the toggle select entities

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe int NXOpen.CAE.HotspotRecipeBuilder.MaxNumRegions

getset

Returns or sets the i max regions

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe int NXOpen.CAE.HotspotRecipeBuilder.MinSpanOfRegion

getset

Returns or sets the min span region

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe double NXOpen.CAE.HotspotRecipeBuilder.NeighborOffset

getset

Returns or sets the i neighbor offset

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.GetNeighbourOffset instead.

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumOffsetTypeMinMax NXOpen.CAE.HotspotRecipeBuilder.OffsetTypeMinMax

getset

Returns or sets the enum sort min max res by

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe string NXOpen.CAE.HotspotRecipeBuilder.RecipeName

getset

Returns or sets the name str

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.Result.Component NXOpen.CAE.HotspotRecipeBuilder.ResultComponent

getset

Returns or sets the enum res comp

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.Result.Location NXOpen.CAE.HotspotRecipeBuilder.ResultLocation

getset

Returns or sets the enum result loc

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe double NXOpen.CAE.HotspotRecipeBuilder.SortAboveParamVal

getset

Returns or sets the d sort above

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.GetSortAboveParamVal instead.

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe double NXOpen.CAE.HotspotRecipeBuilder.SortBelowParamVal

getset

Returns or sets the d sort below

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.GetSortBelowParamVal instead.

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumSortingMethod NXOpen.CAE.HotspotRecipeBuilder.SortMethod

getset

Returns or sets the enum sort method

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe int NXOpen.CAE.HotspotRecipeBuilder.SpanOfRegion

getset

Returns or sets the i span region

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.HotspotRecipeBuilder.EnumThresholdType NXOpen.CAE.HotspotRecipeBuilder.ThresholdType

getset

Returns or sets the enum threshold type

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe double NXOpen.CAE.HotspotRecipeBuilder.ThresholdValue

getset

Returns or sets the d threshold val

Created in NX1872.0.0

Deprecated in NX1899.0.0. Use NXOpen.CAE.HotspotRecipeBuilder.GetThresholdValue instead.

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

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

CAE_HotspotRecipeBuilder.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation