ResultVariable Class

class NXOpen.CAE.ResultVariable

Bases: NXOpen.Fields.NameVariable

Controls Result Exp Object.

To obtain an instance of this class use CAE::ResultManager

New in version NX10.0.0.

Properties

Property Description
Abs Returns or sets the Absolute value from result
Addfillets Returns or sets the Beam fillets
BeamSect Returns or sets the beam section
Comp Returns or sets the Component
Complex Returns or sets the Complex type
Csys Returns or sets the Co-ordinate System
Derivebeamres Returns or sets the Derive beam results
Elementcriteria Returns or sets the elemental result criteria
Elemtypes Returns or sets the Element types
Expname Returns the Result Field Expression Name
Filletradscale Returns or sets the Fillet radius scale factor
IncludeInternalElement Returns or sets the Include Internal Elements which doing nodal averaging
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Layer Returns or sets the layer
Loc Returns or sets the Location
Measure Returns the measure of the variable
Mids Returns or sets the MIDs
Name Returns the name of the variable
Nodalcombinetype Returns or sets the Nodal Combination
Numberofcomponent Returns or sets the ply ID
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Phase Returns or sets the Phase angle
Pids Returns or sets the PIDs
Plyid Returns or sets the ply ID
Prototype Returns the prototype of this object if it is an occurrence.
Quan Returns or sets the Quantity
Selectedcsys Returns or sets the Selected Co-ordinate System
ShellSect Returns or sets the shell section
Tag Returns the Tag for this object.
Usertypename Returns or sets the Result type username

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Print Prints a representation of this object to the system log file.
Rename Re-Name Result Variable
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.

Enumerations

ResultVariableNodalCombination Enumeration Element Nodal Combination Options

Property Detail

Abs

ResultVariable.Abs

Returns or sets the Absolute value from result

-------------------------------------

Getter Method

Signature Abs

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Abs

Parameters:abs (bool) –

New in version NX10.0.0.

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

Addfillets

ResultVariable.Addfillets

Returns or sets the Beam fillets

-------------------------------------

Getter Method

Signature Addfillets

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Addfillets

Parameters:addfillets (bool) –

New in version NX10.0.0.

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

BeamSect

ResultVariable.BeamSect

Returns or sets the beam section

-------------------------------------

Getter Method

Signature BeamSect

Returns:
Return type:NXOpen.CAE.ResultSection

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature BeamSect

Parameters:beamSect (NXOpen.CAE.ResultSection) –

New in version NX10.0.0.

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

Comp

ResultVariable.Comp

Returns or sets the Component

-------------------------------------

Getter Method

Signature Comp

Returns:
Return type:NXOpen.CAE.ResultComponent

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Comp

Parameters:loc (NXOpen.CAE.ResultComponent) –

New in version NX10.0.0.

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

Complex

ResultVariable.Complex

Returns or sets the Complex type

-------------------------------------

Getter Method

Signature Complex

Returns:
Return type:NXOpen.CAE.ResultComplex

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Complex

Parameters:complex (NXOpen.CAE.ResultComplex) –

New in version NX10.0.0.

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

Csys

ResultVariable.Csys

Returns or sets the Co-ordinate System

-------------------------------------

Getter Method

Signature Csys

Returns:
Return type:NXOpen.CAE.ResultCoordinateSystem

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Csys

Parameters:csys (NXOpen.CAE.ResultCoordinateSystem) –

New in version NX10.0.0.

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

Derivebeamres

ResultVariable.Derivebeamres

Returns or sets the Derive beam results

-------------------------------------

Getter Method

Signature Derivebeamres

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Derivebeamres

Parameters:derivebeamres (bool) –

New in version NX10.0.0.

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

Elementcriteria

ResultVariable.Elementcriteria

Returns or sets the elemental result criteria

-------------------------------------

Getter Method

Signature Elementcriteria

Returns:
Return type:NXOpen.CAE.ResultElementValueCriterion

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Elementcriteria

Parameters:criteria (NXOpen.CAE.ResultElementValueCriterion) –

New in version NX10.0.0.

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

Elemtypes

ResultVariable.Elemtypes

Returns or sets the Element types

-------------------------------------

Getter Method

Signature Elemtypes

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Elemtypes

Parameters:elemtypes (bool) –

New in version NX10.0.0.

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

Expname

ResultVariable.Expname

Returns the Result Field Expression Name

-------------------------------------

Getter Method

Signature Expname

Returns:user will have to free name after use
Return type:str

New in version NX10.0.0.

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

Filletradscale

ResultVariable.Filletradscale

Returns or sets the Fillet radius scale factor

-------------------------------------

Getter Method

Signature Filletradscale

Returns:
Return type:float

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Filletradscale

Parameters:filletradscale (float) –

New in version NX10.0.0.

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

IncludeInternalElement

ResultVariable.IncludeInternalElement

Returns or sets the Include Internal Elements which doing nodal averaging

-------------------------------------

Getter Method

Signature IncludeInternalElement

Returns:
Return type:bool

New in version NX12.0.0.

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

-------------------------------------

Setter Method

Signature IncludeInternalElement

Parameters:includeinternalelem (bool) –

New in version NX12.0.0.

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

IsOccurrence

ResultVariable.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

ResultVariable.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Layer

ResultVariable.Layer

Returns or sets the layer

-------------------------------------

Getter Method

Signature Layer

Returns:
Return type:int

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Layer

Parameters:layer (int) –

New in version NX10.0.0.

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

Loc

ResultVariable.Loc

Returns or sets the Location

-------------------------------------

Getter Method

Signature Loc

Returns:
Return type:NXOpen.CAE.ResultLocation

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Loc

Parameters:loc (NXOpen.CAE.ResultLocation) –

New in version NX10.0.0.

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

Mids

ResultVariable.Mids

Returns or sets the MIDs

-------------------------------------

Getter Method

Signature Mids

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Mids

Parameters:mids (bool) –

New in version NX10.0.0.

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

Nodalcombinetype

ResultVariable.Nodalcombinetype

Returns or sets the Nodal Combination

-------------------------------------

Getter Method

Signature Nodalcombinetype

Returns:
Return type:NXOpen.CAE.ResultVariableNodalCombination

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Nodalcombinetype

Parameters:computetype (NXOpen.CAE.ResultVariableNodalCombination) –

New in version NX10.0.0.

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

Numberofcomponent

ResultVariable.Numberofcomponent

Returns or sets the ply ID

-------------------------------------

Getter Method

Signature Numberofcomponent

Returns:
Return type:int

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Numberofcomponent

Parameters:numcomponent (int) –

New in version NX10.0.0.

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

OwningComponent

ResultVariable.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ResultVariable.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Phase

ResultVariable.Phase

Returns or sets the Phase angle

-------------------------------------

Getter Method

Signature Phase

Returns:
Return type:float

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Phase

Parameters:phase (float) –

New in version NX10.0.0.

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

Pids

ResultVariable.Pids

Returns or sets the PIDs

-------------------------------------

Getter Method

Signature Pids

Returns:
Return type:bool

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Pids

Parameters:mids (bool) –

New in version NX10.0.0.

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

Plyid

ResultVariable.Plyid

Returns or sets the ply ID

-------------------------------------

Getter Method

Signature Plyid

Returns:
Return type:int

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Plyid

Parameters:plyid (int) –

New in version NX10.0.0.

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

Prototype

ResultVariable.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Quan

ResultVariable.Quan

Returns or sets the Quantity

-------------------------------------

Getter Method

Signature Quan

Returns:
Return type:NXOpen.CAE.ResultQuantity

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Quan

Parameters:quan (NXOpen.CAE.ResultQuantity) –

New in version NX10.0.0.

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

Selectedcsys

ResultVariable.Selectedcsys

Returns or sets the Selected Co-ordinate System

-------------------------------------

Getter Method

Signature Selectedcsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Selectedcsys

Parameters:selectedcsys (NXOpen.CoordinateSystem) –

New in version NX10.0.0.

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

ShellSect

ResultVariable.ShellSect

Returns or sets the shell section

-------------------------------------

Getter Method

Signature ShellSect

Returns:
Return type:NXOpen.CAE.ResultSection

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature ShellSect

Parameters:sect (NXOpen.CAE.ResultSection) –

New in version NX10.0.0.

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

Usertypename

ResultVariable.Usertypename

Returns or sets the Result type username

-------------------------------------

Getter Method

Signature Usertypename

Returns:user will have to free name after use
Return type:str

New in version NX10.0.0.

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

-------------------------------------

Setter Method

Signature Usertypename

Parameters:usertypename (str) –

New in version NX10.0.0.

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

Method Detail

FindObject

ResultVariable.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Print

ResultVariable.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

Rename

ResultVariable.Rename

Re-Name Result Variable

Signature Rename(expname)

Parameters:expname (str) –

New in version NX10.0.0.

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

SetName

ResultVariable.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.