Result probe Builder
An instance of this class can not be obtained
Default values. More...

Inheritance diagram for NXOpen::CAE::ResultProbeBuilder:

Public Types
enum	CombineAcrossEntities { CombineAcrossEntitiesArithmeticMean, CombineAcrossEntitiesMinimum, CombineAcrossEntitiesMaximum, CombineAcrossEntitiesSum, CombineAcrossEntitiesDifference, CombineAcrossEntitiesWeightedAverage, CombineAcrossEntitiesIntegral }
	Options to combine multiple geometry values. More...

enum	CombineAcrossIterations { CombineAcrossIterationsArithmeticMean, CombineAcrossIterationsAbsoluteMaximum, CombineAcrossIterationsMaximum, CombineAcrossIterationsAbsoluteMinimum, CombineAcrossIterationsMinimum, CombineAcrossIterationsSum }
	Iteration combination types. More...

enum	EdgeIntegral { EdgeIntegralLength, EdgeIntegralArea }
	Options to calculate CAE::ResultProbeBuilder::GeometryValueWeightedAverage or CAE::ResultProbeBuilder::GeometryValueIntegral over elements on an edge. More...

enum	ErrorHandling { ErrorHandlingFillzero, ErrorHandlingSkip }
	Options to handel errornious conditions. More...

enum	FaceIntegral { FaceIntegralArea, FaceIntegralVolume }
	Options to calculate CAE::ResultProbeBuilder::GeometryValueWeightedAverage or CAE::ResultProbeBuilder::GeometryValueIntegral over elements on an face. More...

enum	GeometryValue { GeometryValueArithmeticMean, GeometryValueMinimum, GeometryValueMaximum, GeometryValueSum, GeometryValueWeightedAverage, GeometryValueIntegral, GeometryValueNone }
	Options to combine geometry value. More...

enum	IterationSelection { IterationSelectionFirst, IterationSelectionLast, IterationSelectionNeartoValue, IterationSelectionSpecifyIndex, IterationSelectionAll, IterationSelectionSpecifyRange, IterationSelectionBetweenValues, IterationSelectionNone, IterationSelectionAtValue }
	Iteration definition method. More...

enum	IterationType { IterationTypeTime, IterationTypeFrequency, IterationTypeLoadFactor, IterationTypeEigenValue, IterationTypeAll }
	Iteration type filter. More...

enum	LoadcaseSelection { LoadcaseSelectionFirst, LoadcaseSelectionLast, LoadcaseSelectionSpecifyIndex, LoadcaseSelectionAll, LoadcaseSelectionIgnore, LoadcaseSelectionNone }
	Loadcase definition method. More...

enum	NodalCombination { NodalCombinationArithmeticMean, NodalCombinationMinimum, NodalCombinationMaximum, NodalCombinationSum }
	Options to combine multiple geometry values. More...

enum	SelectionType { SelectionTypeEntireModel, SelectionTypeNodes, SelectionTypeElements, SelectionTypePoints, SelectionTypeEdges, SelectionTypeFaces, SelectionTypeBodies, SelectionTypeQueryCurve, SelectionTypeNone }
	Type of objects where probe value will be calculated. More...

enum	SuperIterType { SuperIterTypeNone, SuperIterTypeHarmonic, SuperIterTypeRotationSpeed, SuperIterTypeDesignCycle, SuperIterTypeAcoustic }
	Super iteration definition method. More...

Public Member Functions
int	AcousticModeIndex ()
	Returns the acousticModes index Created in NX12.0.0. More...

bool	CombineAcross ()
	Returns the combine across Created in NX10.0.0. More...

bool	CombineAcrossIteration ()
	Returns the combine geom Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::CombineAcrossEntities	CombinedValue ()
	Returns the combined value Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::CombineAcrossIterations	CombineIterOption ()
	Returns the combine option Created in NX10.0.0. More...

int	DesignCycleIndex ()
	Returns the desingCycle index Created in NX12.0.0. More...

NXOpen::CAE::ResultProbeBuilder::EdgeIntegral	EdgeIntegralOption ()
	Returns the face integral option Created in NX10.0.0. More...

int	EndIterIndex ()
	Returns the end iter index Created in NX10.0.0. More...

double	EndIterValue ()
	Returns the end iter value Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::ErrorHandling	ErrorHndl ()
	Returns the error handel value Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::FaceIntegral	FaceIntegralOption ()
	Returns the face integral option Created in NX10.0.0. More...

NXString	Formula ()
	Returns the formula Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::GeometryValue	GeometryAverageValue ()
	Returns the geometry average value Created in NX10.0.0. More...

std::vector< NXString >	GetDescription ()
	Returns the description. More...

int	HarmonicIndex ()
	Returns the harmonic index Created in NX11.0.0. More...

NXOpen::CAE::ResultProbeBuilder::IterationSelection	Iteration ()
	Returns the iteration Created in NX10.0.0. More...

int	IterationIndex ()
	Returns the iteration index Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::IterationType	IterationTypeOption ()
	Returns the iteration type Created in NX10.0.0. More...

double	IterNearValue ()
	Returns the iteration value Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::LoadcaseSelection	Loadcase ()
	Returns the loadcase Created in NX10.0.0. More...

int	LoadcaseIndex ()
	Returns the loadcase index Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::SelectionType	ModelSelectionType ()
	Returns the model selection type Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::NodalCombination	NodalAveraging ()
	Returns the nodal combinatione Created in NX10.0.0. More...

bool	PickSequentially ()
	Returns the pick sequentially Created in NX10.0.0. More...

NXString	ProbeName ()
	Returns the probe name Created in NX10.0.0. More...

NXOpen::CAE::QueryCurveUsageOptions *	QueryCurveUsageOptions ()
	Returns the query curve usage options Created in NX11.0.0. More...

NXOpen::CAE::SimResultReference::Type	ResultReferenceType ()
	Returns the result reference type Created in NX10.0.0. More...

NXOpen::CAE::Result::Quantity	ResultType ()
	Returns the output result type value Created in NX10.0.0. More...

double	RotationSpeedValue ()
	Returns the rotation speed value Created in NX11.0.0. More...

void	SetAcousticModeIndex (int acousticModeIndex)
	Sets the acousticModes index Created in NX12.0.0. More...

void	SetCombineAcross (bool combineAcross)
	Sets the combine across Created in NX10.0.0. More...

void	SetCombineAcrossIteration (bool combineIteration)
	Sets the combine geom Created in NX10.0.0. More...

void	SetCombinedValue (NXOpen::CAE::ResultProbeBuilder::CombineAcrossEntities combinedValue)
	Sets the combined value Created in NX10.0.0. More...

void	SetCombineIterOption (NXOpen::CAE::ResultProbeBuilder::CombineAcrossIterations combineOption)
	Sets the combine option Created in NX10.0.0. More...

void	SetDescription (const std::vector< NXString > &description)
	Sets the description Created in NX10.0.0. More...

void	SetDesignCycleIndex (int designCycleIndex)
	Sets the desingCycle index Created in NX12.0.0. More...

void	SetEdgeIntegralOption (NXOpen::CAE::ResultProbeBuilder::EdgeIntegral edgeIntegral)
	Sets the face integral option Created in NX10.0.0. More...

void	SetEndIterIndex (int endIterIndex)
	Sets the end iter index Created in NX10.0.0. More...

void	SetEndIterValue (double endIterValue)
	Sets the end iter value Created in NX10.0.0. More...

void	SetEntityObjects (const std::vector< NXOpen::TaggedObject * > &entityObjs)
	Sets the entity objects for extracting result data. More...

void	SetErrorHndl (NXOpen::CAE::ResultProbeBuilder::ErrorHandling errorHndl)
	Sets the error handel value Created in NX10.0.0. More...

void	SetFaceIntegralOption (NXOpen::CAE::ResultProbeBuilder::FaceIntegral faceIntegral)
	Sets the face integral option Created in NX10.0.0. More...

void	SetFormula (const NXString &formula)
	Sets the formula Created in NX10.0.0. More...

void	SetFormula (const char *formula)
	Sets the formula Created in NX10.0.0. More...

void	SetGeometryAverageValue (NXOpen::CAE::ResultProbeBuilder::GeometryValue geometryAverageValue)
	Sets the geometry average value Created in NX10.0.0. More...

void	SetHarmonicIndex (int harmonicIndex)
	Sets the harmonic index Created in NX11.0.0. More...

void	SetIteration (NXOpen::CAE::ResultProbeBuilder::IterationSelection iteration)
	Sets the iteration Created in NX10.0.0. More...

void	SetIterationIndex (int iterationIndex)
	Sets the iteration index Created in NX10.0.0. More...

void	SetIterationTypeOption (NXOpen::CAE::ResultProbeBuilder::IterationType iterationType)
	Sets the iteration type Created in NX10.0.0. More...

void	SetIterNearValue (double iterValue)
	Sets the iteration value Created in NX10.0.0. More...

void	SetLoadcase (NXOpen::CAE::ResultProbeBuilder::LoadcaseSelection loadcase)
	Sets the loadcase Created in NX10.0.0. More...

void	SetLoadcaseIndex (int loadcaseIndex)
	Sets the loadcase index Created in NX10.0.0. More...

void	SetModelSelectionType (NXOpen::CAE::ResultProbeBuilder::SelectionType modelSelectionType)
	Sets the model selection type Created in NX10.0.0. More...

void	SetNodalAveraging (NXOpen::CAE::ResultProbeBuilder::NodalCombination nodalCombination)
	Sets the nodal combinatione Created in NX10.0.0. More...

void	SetPickSequentially (bool pickSequentially)
	Sets the pick sequentially Created in NX10.0.0. More...

void	SetProbeName (const NXString &probeName)
	Sets the probe name Created in NX10.0.0. More...

void	SetProbeName (const char *probeName)
	Sets the probe name Created in NX10.0.0. More...

void	SetResultReferenceType (NXOpen::CAE::SimResultReference::Type type)
	Sets the result reference type Created in NX10.0.0. More...

void	SetResultType (NXOpen::CAE::Result::Quantity resultType)
	Sets the output result type value Created in NX10.0.0. More...

void	SetRotationSpeedValue (double rotationSpeedValue)
	Sets the rotation speed value Created in NX11.0.0. More...

void	SetSkipSteps (int skipSteps)
	Sets the skip steps Created in NX10.0.0. More...

void	SetStartIterIndex (int startIterIndex)
	Sets the start iter index Created in NX10.0.0. More...

void	SetStartIterValue (double startIterValue)
	Sets the start iter value Created in NX10.0.0. More...

void	SetSuperIterationType (NXOpen::CAE::ResultProbeBuilder::SuperIterType superIterationType)
	Sets the query curve options Created in NX11.0.0. More...

void	SetUnit (NXOpen::Unit *unit)
	Sets the unit Created in NX10.0.0. More...

int	SkipSteps ()
	Returns the skip steps Created in NX10.0.0. More...

int	StartIterIndex ()
	Returns the start iter index Created in NX10.0.0. More...

double	StartIterValue ()
	Returns the start iter value Created in NX10.0.0. More...

NXOpen::CAE::ResultProbeBuilder::SuperIterType	SuperIterationType ()
	Returns the query curve options Created in NX11.0.0. More...

NXOpen::Unit *	Unit ()
	Returns the unit Created in NX10.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Result probe Builder
An instance of this class can not be obtained
Default values.

Property

Value

QueryCurveUsageOptions.CurveUsage

UseVertices

QueryCurveUsageOptions.DistanceTolerance

0

QueryCurveUsageOptions.ResultantCurveLocator

UseAsIs

QueryCurveUsageOptions.ResultantLocationTolerance

0

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::ResultProbeBuilder::CombineAcrossEntities

Options to combine multiple geometry values.

Enumerator
CombineAcrossEntitiesArithmeticMean	arithmetic mean
CombineAcrossEntitiesMinimum	minimum
CombineAcrossEntitiesMaximum	maximum
CombineAcrossEntitiesSum	sum
CombineAcrossEntitiesDifference	difference
CombineAcrossEntitiesWeightedAverage	weighted average
CombineAcrossEntitiesIntegral	integral

enum NXOpen::CAE::ResultProbeBuilder::CombineAcrossIterations

Iteration combination types.

Enumerator
CombineAcrossIterationsArithmeticMean	arithmetic mean
CombineAcrossIterationsAbsoluteMaximum	absolute maximum
CombineAcrossIterationsMaximum	maximum
CombineAcrossIterationsAbsoluteMinimum	absolute minimum
CombineAcrossIterationsMinimum	minimum
CombineAcrossIterationsSum	sum

enum NXOpen::CAE::ResultProbeBuilder::EdgeIntegral

Options to calculate CAE::ResultProbeBuilder::GeometryValueWeightedAverage or CAE::ResultProbeBuilder::GeometryValueIntegral over elements on an edge.

Enumerator
EdgeIntegralLength	length
EdgeIntegralArea	area

enum NXOpen::CAE::ResultProbeBuilder::ErrorHandling

Options to handel errornious conditions.

Enumerator
ErrorHandlingFillzero	fillzero
ErrorHandlingSkip	skip

enum NXOpen::CAE::ResultProbeBuilder::FaceIntegral

Options to calculate CAE::ResultProbeBuilder::GeometryValueWeightedAverage or CAE::ResultProbeBuilder::GeometryValueIntegral over elements on an face.

Enumerator
FaceIntegralArea	area
FaceIntegralVolume	volume

enum NXOpen::CAE::ResultProbeBuilder::GeometryValue

Options to combine geometry value.

Enumerator
GeometryValueArithmeticMean	arithmetic mean
GeometryValueMinimum	minimum
GeometryValueMaximum	maximum
GeometryValueSum	sum
GeometryValueWeightedAverage	weighted average
GeometryValueIntegral	integral
GeometryValueNone	none

enum NXOpen::CAE::ResultProbeBuilder::IterationSelection

Iteration definition method.

Enumerator
IterationSelectionFirst	first
IterationSelectionLast	last
IterationSelectionNeartoValue	nearto value
IterationSelectionSpecifyIndex	specify index
IterationSelectionAll	all
IterationSelectionSpecifyRange	specify range
IterationSelectionBetweenValues	between values
IterationSelectionNone	none
IterationSelectionAtValue	at value

enum NXOpen::CAE::ResultProbeBuilder::IterationType

Iteration type filter.

Enumerator
IterationTypeTime	time
IterationTypeFrequency	frequency
IterationTypeLoadFactor	load factor
IterationTypeEigenValue	eigen value
IterationTypeAll	all

enum NXOpen::CAE::ResultProbeBuilder::LoadcaseSelection

Loadcase definition method.

Enumerator
LoadcaseSelectionFirst	first
LoadcaseSelectionLast	last
LoadcaseSelectionSpecifyIndex	specify index
LoadcaseSelectionAll	all
LoadcaseSelectionIgnore	ignore
LoadcaseSelectionNone	none

enum NXOpen::CAE::ResultProbeBuilder::NodalCombination

Options to combine multiple geometry values.

Enumerator
NodalCombinationArithmeticMean	arithmetic mean
NodalCombinationMinimum	minimum
NodalCombinationMaximum	maximum
NodalCombinationSum	sum

enum NXOpen::CAE::ResultProbeBuilder::SelectionType

Type of objects where probe value will be calculated.

Enumerator
SelectionTypeEntireModel	entire model
SelectionTypeNodes	nodes
SelectionTypeElements	elements
SelectionTypePoints	points
SelectionTypeEdges	edges
SelectionTypeFaces	faces
SelectionTypeBodies	bodies
SelectionTypeQueryCurve	query curve
SelectionTypeNone	none

enum NXOpen::CAE::ResultProbeBuilder::SuperIterType

Super iteration definition method.

Enumerator
SuperIterTypeNone	none
SuperIterTypeHarmonic	harmonic
SuperIterTypeRotationSpeed	rotation speed
SuperIterTypeDesignCycle	design cycle
SuperIterTypeAcoustic	acoustic

Member Function Documentation

int NXOpen::CAE::ResultProbeBuilder::AcousticModeIndex ( )

Returns the acousticModes index
Created in NX12.0.0.

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

bool NXOpen::CAE::ResultProbeBuilder::CombineAcross ( )

Returns the combine across
Created in NX10.0.0.

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

bool NXOpen::CAE::ResultProbeBuilder::CombineAcrossIteration ( )

Returns the combine geom
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::CombineAcrossEntities NXOpen::CAE::ResultProbeBuilder::CombinedValue ( )

Returns the combined value
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::CombineAcrossIterations NXOpen::CAE::ResultProbeBuilder::CombineIterOption ( )

Returns the combine option
Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::DesignCycleIndex ( )

Returns the desingCycle index
Created in NX12.0.0.

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

NXOpen::CAE::ResultProbeBuilder::EdgeIntegral NXOpen::CAE::ResultProbeBuilder::EdgeIntegralOption ( )

Returns the face integral option
Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::EndIterIndex ( )

Returns the end iter index
Created in NX10.0.0.

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

double NXOpen::CAE::ResultProbeBuilder::EndIterValue ( )

Returns the end iter value
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::ErrorHandling NXOpen::CAE::ResultProbeBuilder::ErrorHndl ( )

Returns the error handel value
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::FaceIntegral NXOpen::CAE::ResultProbeBuilder::FaceIntegralOption ( )

Returns the face integral option
Created in NX10.0.0.

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

NXString NXOpen::CAE::ResultProbeBuilder::Formula ( )

Returns the formula
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::GeometryValue NXOpen::CAE::ResultProbeBuilder::GeometryAverageValue ( )

Returns the geometry average value
Created in NX10.0.0.

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

std::vector<NXString> NXOpen::CAE::ResultProbeBuilder::GetDescription ( )

Returns the description.

Returns: Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::HarmonicIndex ( )

Returns the harmonic index
Created in NX11.0.0.

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

NXOpen::CAE::ResultProbeBuilder::IterationSelection NXOpen::CAE::ResultProbeBuilder::Iteration ( )

Returns the iteration
Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::IterationIndex ( )

Returns the iteration index
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::IterationType NXOpen::CAE::ResultProbeBuilder::IterationTypeOption ( )

Returns the iteration type
Created in NX10.0.0.

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

double NXOpen::CAE::ResultProbeBuilder::IterNearValue ( )

Returns the iteration value
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::LoadcaseSelection NXOpen::CAE::ResultProbeBuilder::Loadcase ( )

Returns the loadcase
Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::LoadcaseIndex ( )

Returns the loadcase index
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::SelectionType NXOpen::CAE::ResultProbeBuilder::ModelSelectionType ( )

Returns the model selection type
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::NodalCombination NXOpen::CAE::ResultProbeBuilder::NodalAveraging ( )

Returns the nodal combinatione
Created in NX10.0.0.

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

bool NXOpen::CAE::ResultProbeBuilder::PickSequentially ( )

Returns the pick sequentially
Created in NX10.0.0.

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

NXString NXOpen::CAE::ResultProbeBuilder::ProbeName ( )

Returns the probe name
Created in NX10.0.0.

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

NXOpen::CAE::QueryCurveUsageOptions* NXOpen::CAE::ResultProbeBuilder::QueryCurveUsageOptions ( )

Returns the query curve usage options
Created in NX11.0.0.

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

NXOpen::CAE::SimResultReference::Type NXOpen::CAE::ResultProbeBuilder::ResultReferenceType ( )

Returns the result reference type
Created in NX10.0.0.

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

NXOpen::CAE::Result::Quantity NXOpen::CAE::ResultProbeBuilder::ResultType ( )

Returns the output result type value
Created in NX10.0.0.

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

double NXOpen::CAE::ResultProbeBuilder::RotationSpeedValue ( )

Returns the rotation speed value
Created in NX11.0.0.

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

void NXOpen::CAE::ResultProbeBuilder::SetAcousticModeIndex ( int acousticModeIndex )

Sets the acousticModes index
Created in NX12.0.0.

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

Parameters

acousticModeIndex acousticmodeindex

void NXOpen::CAE::ResultProbeBuilder::SetCombineAcross ( bool combineAcross )

Sets the combine across
Created in NX10.0.0.

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

Parameters

combineAcross combineacross

void NXOpen::CAE::ResultProbeBuilder::SetCombineAcrossIteration ( bool combineIteration )

Sets the combine geom
Created in NX10.0.0.

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

Parameters

combineIteration combineiteration

void NXOpen::CAE::ResultProbeBuilder::SetCombinedValue ( NXOpen::CAE::ResultProbeBuilder::CombineAcrossEntities combinedValue )

Sets the combined value
Created in NX10.0.0.

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

Parameters

combinedValue combinedvalue

void NXOpen::CAE::ResultProbeBuilder::SetCombineIterOption ( NXOpen::CAE::ResultProbeBuilder::CombineAcrossIterations combineOption )

Sets the combine option
Created in NX10.0.0.

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

Parameters

combineOption combineoption

void NXOpen::CAE::ResultProbeBuilder::SetDescription ( const std::vector< NXString > & description )

Sets the description
Created in NX10.0.0.

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

Parameters

description description

void NXOpen::CAE::ResultProbeBuilder::SetDesignCycleIndex ( int designCycleIndex )

Sets the desingCycle index
Created in NX12.0.0.

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

Parameters

designCycleIndex designcycleindex

void NXOpen::CAE::ResultProbeBuilder::SetEdgeIntegralOption ( NXOpen::CAE::ResultProbeBuilder::EdgeIntegral edgeIntegral )

Sets the face integral option
Created in NX10.0.0.

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

Parameters

edgeIntegral edgeintegral

void NXOpen::CAE::ResultProbeBuilder::SetEndIterIndex ( int endIterIndex )

Sets the end iter index
Created in NX10.0.0.

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

Parameters

endIterIndex enditerindex

void NXOpen::CAE::ResultProbeBuilder::SetEndIterValue ( double endIterValue )

Sets the end iter value
Created in NX10.0.0.

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

Parameters

endIterValue enditervalue

void NXOpen::CAE::ResultProbeBuilder::SetEntityObjects ( const std::vector< NXOpen::TaggedObject * > & entityObjs )

Sets the entity objects for extracting result data.

Objects passed to this method are of the type defined by CAE::ResultProbeBuilder::ModelSelectionType . The types of objects allowed to be set are is defined by the NXOpen::CAE::ResultProbeBuilder::SelectionType .

Created in NX10.0.0.

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

Parameters

entityObjs entityobjs

void NXOpen::CAE::ResultProbeBuilder::SetErrorHndl ( NXOpen::CAE::ResultProbeBuilder::ErrorHandling errorHndl )

Sets the error handel value
Created in NX10.0.0.

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

Parameters

errorHndl errorhndl

void NXOpen::CAE::ResultProbeBuilder::SetFaceIntegralOption ( NXOpen::CAE::ResultProbeBuilder::FaceIntegral faceIntegral )

Sets the face integral option
Created in NX10.0.0.

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

Parameters

faceIntegral faceintegral

void NXOpen::CAE::ResultProbeBuilder::SetFormula ( const NXString & formula )

Sets the formula
Created in NX10.0.0.

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

Parameters

formula formula

void NXOpen::CAE::ResultProbeBuilder::SetFormula ( const char * formula )

Sets the formula
Created in NX10.0.0.

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

Parameters

formula formula

void NXOpen::CAE::ResultProbeBuilder::SetGeometryAverageValue ( NXOpen::CAE::ResultProbeBuilder::GeometryValue geometryAverageValue )

Sets the geometry average value
Created in NX10.0.0.

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

Parameters

geometryAverageValue geometryaveragevalue

void NXOpen::CAE::ResultProbeBuilder::SetHarmonicIndex ( int harmonicIndex )

Sets the harmonic index
Created in NX11.0.0.

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

Parameters

harmonicIndex harmonicindex

void NXOpen::CAE::ResultProbeBuilder::SetIteration ( NXOpen::CAE::ResultProbeBuilder::IterationSelection iteration )

Sets the iteration
Created in NX10.0.0.

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

Parameters

iteration iteration

void NXOpen::CAE::ResultProbeBuilder::SetIterationIndex ( int iterationIndex )

Sets the iteration index
Created in NX10.0.0.

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

Parameters

iterationIndex iterationindex

void NXOpen::CAE::ResultProbeBuilder::SetIterationTypeOption ( NXOpen::CAE::ResultProbeBuilder::IterationType iterationType )

Sets the iteration type
Created in NX10.0.0.

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

Parameters

iterationType iterationtype

void NXOpen::CAE::ResultProbeBuilder::SetIterNearValue ( double iterValue )

Sets the iteration value
Created in NX10.0.0.

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

Parameters

iterValue itervalue

void NXOpen::CAE::ResultProbeBuilder::SetLoadcase ( NXOpen::CAE::ResultProbeBuilder::LoadcaseSelection loadcase )

Sets the loadcase
Created in NX10.0.0.

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

Parameters

loadcase loadcase

void NXOpen::CAE::ResultProbeBuilder::SetLoadcaseIndex ( int loadcaseIndex )

Sets the loadcase index
Created in NX10.0.0.

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

Parameters

loadcaseIndex loadcaseindex

void NXOpen::CAE::ResultProbeBuilder::SetModelSelectionType ( NXOpen::CAE::ResultProbeBuilder::SelectionType modelSelectionType )

Sets the model selection type
Created in NX10.0.0.

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

Parameters

modelSelectionType modelselectiontype

void NXOpen::CAE::ResultProbeBuilder::SetNodalAveraging ( NXOpen::CAE::ResultProbeBuilder::NodalCombination nodalCombination )

Sets the nodal combinatione
Created in NX10.0.0.

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

Parameters

nodalCombination nodalcombination

void NXOpen::CAE::ResultProbeBuilder::SetPickSequentially ( bool pickSequentially )

Sets the pick sequentially
Created in NX10.0.0.

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

Parameters

pickSequentially picksequentially

void NXOpen::CAE::ResultProbeBuilder::SetProbeName ( const NXString & probeName )

Sets the probe name
Created in NX10.0.0.

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

Parameters

probeName probename

void NXOpen::CAE::ResultProbeBuilder::SetProbeName ( const char * probeName )

Sets the probe name
Created in NX10.0.0.

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

Parameters

probeName probename

void NXOpen::CAE::ResultProbeBuilder::SetResultReferenceType ( NXOpen::CAE::SimResultReference::Type type )

Sets the result reference type
Created in NX10.0.0.

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

Parameters

type type

void NXOpen::CAE::ResultProbeBuilder::SetResultType ( NXOpen::CAE::Result::Quantity resultType )

Sets the output result type value
Created in NX10.0.0.

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

Parameters

resultType resulttype

void NXOpen::CAE::ResultProbeBuilder::SetRotationSpeedValue ( double rotationSpeedValue )

Sets the rotation speed value
Created in NX11.0.0.

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

Parameters

rotationSpeedValue rotationspeedvalue

void NXOpen::CAE::ResultProbeBuilder::SetSkipSteps ( int skipSteps )

Sets the skip steps
Created in NX10.0.0.

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

Parameters

skipSteps skipsteps

void NXOpen::CAE::ResultProbeBuilder::SetStartIterIndex ( int startIterIndex )

Sets the start iter index
Created in NX10.0.0.

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

Parameters

startIterIndex startiterindex

void NXOpen::CAE::ResultProbeBuilder::SetStartIterValue ( double startIterValue )

Sets the start iter value
Created in NX10.0.0.

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

Parameters

startIterValue startitervalue

void NXOpen::CAE::ResultProbeBuilder::SetSuperIterationType ( NXOpen::CAE::ResultProbeBuilder::SuperIterType superIterationType )

Sets the query curve options
Created in NX11.0.0.

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

Parameters

superIterationType superiterationtype

void NXOpen::CAE::ResultProbeBuilder::SetUnit ( NXOpen::Unit * unit )

Sets the unit
Created in NX10.0.0.

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

Parameters

unit unit

int NXOpen::CAE::ResultProbeBuilder::SkipSteps ( )

Returns the skip steps
Created in NX10.0.0.

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

int NXOpen::CAE::ResultProbeBuilder::StartIterIndex ( )

Returns the start iter index
Created in NX10.0.0.

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

double NXOpen::CAE::ResultProbeBuilder::StartIterValue ( )

Returns the start iter value
Created in NX10.0.0.

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

NXOpen::CAE::ResultProbeBuilder::SuperIterType NXOpen::CAE::ResultProbeBuilder::SuperIterationType ( )

Returns the query curve options
Created in NX11.0.0.

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

NXOpen::Unit* NXOpen::CAE::ResultProbeBuilder::Unit ( )

Returns the unit
Created in NX10.0.0.

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

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

CAE_ResultProbeBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation