SimLoadSet Class

class NXOpen.CAE.SimLoadSet

Bases: NXOpen.CAE.NamedPropertyTable, NXOpen.CAE.IExportableFEEntity

Represents a cae load set object

To create a new instance of this class, use NXOpen.CAE.SimLoadSetCollection.CreateLoadSet()

New in version NX10.0.0.

Properties

Property	Description
DescriptorName	Returns the name of the load set descriptor
DescriptorType	Returns the descriptor name defines the type of the property table in named property table holder
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Label	Returns or sets the label of the named property table holder
LanguageName	Returns the lanugage of the descriptor that defines the type of the property table in named property table holder
LoadSetType	Returns the type of the load set
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
PropertyTable	Returns the property table of the named property table holder
Prototype	Returns the prototype of this object if it is an occurrence.
SolverName	Returns the solver of lanugage of the descriptor that defines the type of the property table in named property table holder
Tag	Returns the Tag for this object.

Methods

Method	Description
AddMemberFolders	Add root folder members to load set.
AddMemberLoads	Add load members to load set.
AddMemberSet	Add a load set member to load set.
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.
GetMemberFolderValidLoads	Get all valid loads under given root folder in given load set
GetMemberFolders	Get all root folder memebers of load set
GetMemberLoads	Get all load memebers from load set
GetMemberSet	Get the load set memeber from load set
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.
GetSolverCardSyntax	Returns the solver card syntax strings for this entity.
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.
RemoveMemberFolders	Remove root folder memebers from load set
RemoveMemberLoads	Remove load memebers from load set
RemoveMemberSet	Remove a load set memeber from load set
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

SimLoadSetType Enumeration

Load Set type

Property Detail

DescriptorName

SimLoadSet.DescriptorName

Returns the name of the load set descriptor

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

Getter Method

Signature DescriptorName

Returns: Return type:str

New in version NX10.0.0.

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

IsOccurrence

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

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

LoadSetType

SimLoadSet.LoadSetType

Returns the type of the load set

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

Getter Method

Signature LoadSetType

Returns: Return type:NXOpen.CAE.SimLoadSetType

New in version NX10.0.0.

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

Name

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

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

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

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

AddMemberFolders

SimLoadSet.AddMemberFolders

Add root folder members to load set.

Only load set with type of SimLoadSetType.Static and SimLoadSetType.Acoustic and SimLoadSetType.Temperature can add member folder

Signature AddMemberFolders(tmembers)

Parameters:tmembers (list of NXOpen.CAE.SimLbcFolder) – member folders

New in version NX10.0.0.

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

AddMemberLoads

SimLoadSet.AddMemberLoads

Add load members to load set.

Only load set with type of SimLoadSetType.Static and SimLoadSetType.Acoustic and SimLoadSetType.Temperature can add member load

Signature AddMemberLoads(tmembers)

Parameters:tmembers (list of NXOpen.CAE.SimLoad) – member loads

New in version NX10.0.0.

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

AddMemberSet

SimLoadSet.AddMemberSet

Add a load set member to load set.

Only load set with type of SimLoadSetType.Frequency and SimLoadSetType.Transient can add only one set member with type of SimLoadSetType.Static

Signature AddMemberSet(tmember)

Parameters:tmember (NXOpen.CAE.SimLoadSet) – member load set

New in version NX10.0.0.

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

FindObject

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

GetMemberFolderValidLoads

SimLoadSet.GetMemberFolderValidLoads

Get all valid loads under given root folder in given load set

Signature GetMemberFolderValidLoads(tFolder)

Parameters:tFolder (NXOpen.CAE.SimLbcFolder) – member folder Returns:member loads under folder Return type:list of NXOpen.CAE.SimLoad

New in version NX10.0.0.

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

GetMemberFolders

SimLoadSet.GetMemberFolders

Get all root folder memebers of load set

Signature GetMemberFolders()

Returns:member folders Return type:list of NXOpen.CAE.SimLbcFolder

New in version NX10.0.0.

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

GetMemberLoads

SimLoadSet.GetMemberLoads

Get all load memebers from load set

Signature GetMemberLoads()

Returns:member loads Return type:list of NXOpen.CAE.SimLoad

New in version NX10.0.0.

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

GetMemberSet

SimLoadSet.GetMemberSet

Get the load set memeber from load set

Signature GetMemberSet()

Returns:member load set Return type:NXOpen.CAE.SimLoadSet

New in version NX10.0.0.

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

GetSolverCardSyntax

SimLoadSet.GetSolverCardSyntax

Returns the solver card syntax strings for this entity.

Signature GetSolverCardSyntax()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: None.

Print

SimLoadSet.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveMemberFolders

SimLoadSet.RemoveMemberFolders

Remove root folder memebers from load set

Signature RemoveMemberFolders(tmembers)

Parameters:tmembers (list of NXOpen.CAE.SimLbcFolder) – member folders

New in version NX10.0.0.

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

RemoveMemberLoads

SimLoadSet.RemoveMemberLoads

Remove load memebers from load set

Signature RemoveMemberLoads(tmembers)

Parameters:tmembers (list of NXOpen.CAE.SimLoad) – member loads

New in version NX10.0.0.

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

RemoveMemberSet

SimLoadSet.RemoveMemberSet

Remove a load set memeber from load set

Signature RemoveMemberSet(tmember)

Parameters:tmember (NXOpen.CAE.SimLoadSet) – member load set

New in version NX10.0.0.

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

SetName

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