public interface ResultProbeBuilder extends Builder
Modifier and Type | Interface and Description |
---|---|
static class |
ResultProbeBuilder.CombineAcrossEntities
Options to combine multiple geometry values
|
static class |
ResultProbeBuilder.CombineAcrossIterations
Iteration combination types
|
static class |
ResultProbeBuilder.EdgeIntegral
Options to calculate
CAE.ResultProbeBuilder.GeometryValue#WEIGHTED_AVERAGE or
CAE.ResultProbeBuilder.GeometryValue#INTEGRAL over elements on an edge |
static class |
ResultProbeBuilder.ErrorHandling
Options to handel errornious conditions
|
static class |
ResultProbeBuilder.FaceIntegral
Options to calculate
CAE.ResultProbeBuilder.GeometryValue#WEIGHTED_AVERAGE or
CAE.ResultProbeBuilder.GeometryValue#INTEGRAL over elements on an face |
static class |
ResultProbeBuilder.GeometryValue
Options to combine geometry value
|
static class |
ResultProbeBuilder.IterationSelection
Iteration definition method
|
static class |
ResultProbeBuilder.IterationType
Iteration type filter
|
static class |
ResultProbeBuilder.LoadcaseSelection
Loadcase definition method
|
static class |
ResultProbeBuilder.NodalCombination
Options to combine multiple geometry values
|
static class |
ResultProbeBuilder.SelectionType
Type of objects where probe value will be calculated
|
Modifier and Type | Method and Description |
---|---|
boolean |
combineAcross()
Returns the combine across
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
boolean |
combineAcrossIteration()
Returns the combine geom
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.CombineAcrossEntities |
combinedValue()
Returns the combined value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.CombineAcrossIterations |
combineIterOption()
Returns the combine option
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.EdgeIntegral |
edgeIntegralOption()
Returns the face integral option
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
int |
endIterIndex()
Returns the end iter index
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
double |
endIterValue()
Returns the end iter value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.ErrorHandling |
errorHndl()
Returns the error handel value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.FaceIntegral |
faceIntegralOption()
Returns the face integral option
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
String |
formula()
Returns the formula
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.GeometryValue |
geometryAverageValue()
Returns the geometry average value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
String[] |
getDescription()
Returns the description
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.IterationSelection |
iteration()
Returns the iteration
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
int |
iterationIndex()
Returns the iteration index
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.IterationType |
iterationTypeOption()
Returns the iteration type
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
double |
iterNearValue()
Returns the iteration value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.LoadcaseSelection |
loadcase()
Returns the loadcase
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
int |
loadcaseIndex()
Returns the loadcase index
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.SelectionType |
modelSelectionType()
Returns the model selection type
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
ResultProbeBuilder.NodalCombination |
nodalAveraging()
Returns the nodal combinatione
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
boolean |
pickSequentially()
Returns the pick sequentially
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
String |
probeName()
Returns the probe name
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
SimResultReference.Type |
resultReferenceType()
Returns the result reference type
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
Result.Quantity |
resultType()
Returns the output result type value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setCombineAcross(boolean combineAcross)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setCombineAcrossIteration(boolean combineIteration)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setCombinedValue(ResultProbeBuilder.CombineAcrossEntities combinedValue)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setCombineIterOption(ResultProbeBuilder.CombineAcrossIterations combineOption)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setDescription(String[] description)
Sets the description
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setEdgeIntegralOption(ResultProbeBuilder.EdgeIntegral edgeIntegral)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setEndIterIndex(int endIterIndex)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setEndIterValue(double endIterValue)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setEntityObjects(TaggedObject[] entityObjs)
Sets the entity objects for extracting result data.
|
void |
setErrorHndl(ResultProbeBuilder.ErrorHandling errorHndl)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setFaceIntegralOption(ResultProbeBuilder.FaceIntegral faceIntegral)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setFormula(String formula)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setGeometryAverageValue(ResultProbeBuilder.GeometryValue geometryAverageValue)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setIteration(ResultProbeBuilder.IterationSelection iteration)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setIterationIndex(int iterationIndex)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setIterationTypeOption(ResultProbeBuilder.IterationType iterationType)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setIterNearValue(double iterValue)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setLoadcase(ResultProbeBuilder.LoadcaseSelection loadcase)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setLoadcaseIndex(int loadcaseIndex)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setModelSelectionType(ResultProbeBuilder.SelectionType modelSelectionType)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setNodalAveraging(ResultProbeBuilder.NodalCombination nodalCombination)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setPickSequentially(boolean pickSequentially)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setProbeName(String probeName)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setResultReferenceType(SimResultReference.Type type)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setResultType(Result.Quantity resultType)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setSkipSteps(int skipSteps)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setStartIterIndex(int startIterIndex)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setStartIterValue(double startIterValue)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
void |
setUnit(Unit unit)
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
int |
skipSteps()
Returns the skip steps
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
int |
startIterIndex()
Returns the start iter index
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
double |
startIterValue()
Returns the start iter value
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
Unit |
unit()
Returns the unit
License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
String probeName() throws NXException, RemoteException
NXException
RemoteException
void setProbeName(String probeName) throws NXException, RemoteException
probeName
- NXException
RemoteException
String[] getDescription() throws NXException, RemoteException
NXException
RemoteException
void setDescription(String[] description) throws NXException, RemoteException
description
- NXException
RemoteException
String formula() throws NXException, RemoteException
NXException
RemoteException
void setFormula(String formula) throws NXException, RemoteException
formula
- NXException
RemoteException
ResultProbeBuilder.LoadcaseSelection loadcase() throws NXException, RemoteException
NXException
RemoteException
void setLoadcase(ResultProbeBuilder.LoadcaseSelection loadcase) throws NXException, RemoteException
loadcase
- NXException
RemoteException
int loadcaseIndex() throws NXException, RemoteException
NXException
RemoteException
void setLoadcaseIndex(int loadcaseIndex) throws NXException, RemoteException
loadcaseIndex
- NXException
RemoteException
ResultProbeBuilder.IterationSelection iteration() throws NXException, RemoteException
NXException
RemoteException
void setIteration(ResultProbeBuilder.IterationSelection iteration) throws NXException, RemoteException
iteration
- NXException
RemoteException
ResultProbeBuilder.IterationType iterationTypeOption() throws NXException, RemoteException
NXException
RemoteException
void setIterationTypeOption(ResultProbeBuilder.IterationType iterationType) throws NXException, RemoteException
iterationType
- NXException
RemoteException
int iterationIndex() throws NXException, RemoteException
NXException
RemoteException
void setIterationIndex(int iterationIndex) throws NXException, RemoteException
iterationIndex
- NXException
RemoteException
double startIterValue() throws NXException, RemoteException
NXException
RemoteException
void setStartIterValue(double startIterValue) throws NXException, RemoteException
startIterValue
- NXException
RemoteException
double endIterValue() throws NXException, RemoteException
NXException
RemoteException
void setEndIterValue(double endIterValue) throws NXException, RemoteException
endIterValue
- NXException
RemoteException
int startIterIndex() throws NXException, RemoteException
NXException
RemoteException
void setStartIterIndex(int startIterIndex) throws NXException, RemoteException
startIterIndex
- NXException
RemoteException
int endIterIndex() throws NXException, RemoteException
NXException
RemoteException
void setEndIterIndex(int endIterIndex) throws NXException, RemoteException
endIterIndex
- NXException
RemoteException
double iterNearValue() throws NXException, RemoteException
NXException
RemoteException
void setIterNearValue(double iterValue) throws NXException, RemoteException
iterValue
- NXException
RemoteException
int skipSteps() throws NXException, RemoteException
NXException
RemoteException
void setSkipSteps(int skipSteps) throws NXException, RemoteException
skipSteps
- NXException
RemoteException
boolean combineAcrossIteration() throws NXException, RemoteException
NXException
RemoteException
void setCombineAcrossIteration(boolean combineIteration) throws NXException, RemoteException
combineIteration
- NXException
RemoteException
ResultProbeBuilder.CombineAcrossIterations combineIterOption() throws NXException, RemoteException
NXException
RemoteException
void setCombineIterOption(ResultProbeBuilder.CombineAcrossIterations combineOption) throws NXException, RemoteException
combineOption
- NXException
RemoteException
ResultProbeBuilder.SelectionType modelSelectionType() throws NXException, RemoteException
NXException
RemoteException
void setModelSelectionType(ResultProbeBuilder.SelectionType modelSelectionType) throws NXException, RemoteException
modelSelectionType
- NXException
RemoteException
void setEntityObjects(TaggedObject[] entityObjs) throws NXException, RemoteException
CAE.ResultProbeBuilder#modelSelectionType
.
The types of objects allowed to be set are is defined by the
ResultProbeBuilder.SelectionType
.
entityObjs
- NXException
RemoteException
boolean pickSequentially() throws NXException, RemoteException
NXException
RemoteException
void setPickSequentially(boolean pickSequentially) throws NXException, RemoteException
pickSequentially
- NXException
RemoteException
ResultProbeBuilder.GeometryValue geometryAverageValue() throws NXException, RemoteException
NXException
RemoteException
void setGeometryAverageValue(ResultProbeBuilder.GeometryValue geometryAverageValue) throws NXException, RemoteException
geometryAverageValue
- NXException
RemoteException
ResultProbeBuilder.EdgeIntegral edgeIntegralOption() throws NXException, RemoteException
NXException
RemoteException
void setEdgeIntegralOption(ResultProbeBuilder.EdgeIntegral edgeIntegral) throws NXException, RemoteException
edgeIntegral
- NXException
RemoteException
ResultProbeBuilder.FaceIntegral faceIntegralOption() throws NXException, RemoteException
NXException
RemoteException
void setFaceIntegralOption(ResultProbeBuilder.FaceIntegral faceIntegral) throws NXException, RemoteException
faceIntegral
- NXException
RemoteException
boolean combineAcross() throws NXException, RemoteException
NXException
RemoteException
void setCombineAcross(boolean combineAcross) throws NXException, RemoteException
combineAcross
- NXException
RemoteException
ResultProbeBuilder.NodalCombination nodalAveraging() throws NXException, RemoteException
NXException
RemoteException
void setNodalAveraging(ResultProbeBuilder.NodalCombination nodalCombination) throws NXException, RemoteException
nodalCombination
- NXException
RemoteException
ResultProbeBuilder.CombineAcrossEntities combinedValue() throws NXException, RemoteException
NXException
RemoteException
void setCombinedValue(ResultProbeBuilder.CombineAcrossEntities combinedValue) throws NXException, RemoteException
combinedValue
- NXException
RemoteException
ResultProbeBuilder.ErrorHandling errorHndl() throws NXException, RemoteException
NXException
RemoteException
void setErrorHndl(ResultProbeBuilder.ErrorHandling errorHndl) throws NXException, RemoteException
errorHndl
- NXException
RemoteException
Result.Quantity resultType() throws NXException, RemoteException
NXException
RemoteException
void setResultType(Result.Quantity resultType) throws NXException, RemoteException
resultType
- NXException
RemoteException
Unit unit() throws NXException, RemoteException
NXException
RemoteException
void setUnit(Unit unit) throws NXException, RemoteException
unit
- NXException
RemoteException
SimResultReference.Type resultReferenceType() throws NXException, RemoteException
NXException
RemoteException
void setResultReferenceType(SimResultReference.Type type) throws NXException, RemoteException
type
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.