NodalForceReport Class

class NXOpen.CAE.NodalForceReport

Bases: NXOpen.Fields.Field

Free Body Object.

To obtain a instance of this class use an appropriate application data provider.

New in version NX11.0.2.

Properties

Property	Description
Color	Returns or sets the color of the object.
IsBlanked	Returns the blank status of this object.
IsLocked	Returns a value that indicates whether this field is locked against edits.
IsOccurrence	Returns whether this object is an occurrence or not.
IsUserField	Returns a value that indicates whether this field is a user created/managed field.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Layer	Returns or sets the layer that the object is in.
LineFont	Returns or sets the line font of the object.
LineWidth	Returns or sets the line width of the object.
Name	Returns the custom name of the object.
NameLocation	Returns the location of the object’s name.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
AddApplicationData	Adds the specified application data object to the field NOTE: Only one application data object per IApplication can be added and the data must be owned by an IApplication with the same Part::Field::Main as the field.
Blank	Blanks the object.
CopyAsTableToPart	Create a new table field from this field (regardless of type).
CopyToPart	Copy the field to the target part.
CreateAttributeIterator	Create an attribute iterator
CreateCopyInPart	Copy the field to the target part.
CreateDrawHelper	Creates a field drawhelper which can be used to get display attributes of this field.
CreateTableInPart	Create a new table field from this field (regardless of type).
Delete	Delete this field; destroys the field and removes all references to it.
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.
GetApplicationData	Retrieves the application data associated with the field for the specified application.
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.
GetDependentVariables	Returns the dependent variables for this NXOpen.Fields.Field
GetDescription	Returns the description of the field.
GetFieldDrawhelper	Returns a field drawhelper which can be used to get display attributes of this field.
GetFieldEvaluator	Returns a field evaluator which can be used to evaluate this field.
GetIdLabel	Returns the ID/Label of the field.
GetIndependentVariables	Returns the independent variables for this NXOpen.Fields.Field
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.
GetSpatialMap	Returns the spatial map for the formula field if one exists.
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
Highlight	Highlights the object.
Information	Information of the free body results.
Print	Prints a representation of this object to the system log file.
RedisplayObject	Redisplays the object in all views.
RemoveViewDependency	Remove dependency on all views from an object.
Rename	Update the name of the field.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetDescription	Update the description of the field.
SetIdLabel	Update the ID/Label of the field.
SetName	Sets the custom name of the object.
SetNameLocation	Sets the location of the object’s name.
SetPartContext	Set part context.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetSpatialMap	Set the spatial map for the formula field.
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.
Unblank	Unblanks the object.
Unhighlight	Unhighlights the object.
XYGraph	Creates displayed graphs of the Field’s specified independent variable versus all the Field’s dependent variables
XYGraph3D	Plots or overlays graphs of the Field’s specified x-axis and z-axis independent variables versus the Field’s specified y-axis dependent variable ; returns newly created plot object.
XYGraphArgand	Plots the Field’s specified independent variable versus all the Field’s scaled dependent variables as an Argand graph; returns newly created plot object(s).

Enumerations

NodalForceReportForceComponent Enumeration	Free Body Force Components
NodalForceReportSubcaseOption Enumeration	Free Body solution subcase selection options

Property Detail

IsOccurrence

NodalForceReport.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

NodalForceReport.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.

Name

NodalForceReport.Name

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

NodalForceReport.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

NodalForceReport.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.

Prototype

NodalForceReport.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.

Method Detail

FindObject

NodalForceReport.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.

Information

NodalForceReport.Information

Information of the free body results.

Signature Information()

New in version NX11.0.2.

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

Print

NodalForceReport.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

NodalForceReport.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.