SimGroupContainer Class

class NXOpen.CAE.SimGroupContainer

Bases: NXOpen.NXObject

Represents UGS::CaeSim::LbcGroupContainer

This is an abstract class

New in version NX4.0.0.

Properties

Property Description
IsConstraintGroupAllowed Returns a value indicating whether a constraint group is allowed for this group container
IsLoadGroupAllowed Returns a value indicating whether a load group is allowed for this group container
IsOccurrence Returns whether this object is an occurrence or not.
IsSimulationObjectGroupAllowed Returns a value indicating whether a simulation object group is allowed for this group container
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
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
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
CreateConstraintGroup Creates a constraint group for a solution or solution step
CreateLoadGroup Creates a load group for a solution or solution step
CreateSimulationObjectGroup Creates a simulation object group for a solution or solution step
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteGroup Deletes a BC group from this group container
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.
GetGroupCount Returns the number of groups in this container
GetGroups Gets the BC groups in this group container
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.
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.

Property Detail

IsConstraintGroupAllowed

SimGroupContainer.IsConstraintGroupAllowed

Returns a value indicating whether a constraint group is allowed for this group container

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

Getter Method

Signature IsConstraintGroupAllowed

Returns:
Return type:bool

New in version NX9.0.0.

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

IsLoadGroupAllowed

SimGroupContainer.IsLoadGroupAllowed

Returns a value indicating whether a load group is allowed for this group container

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

Getter Method

Signature IsLoadGroupAllowed

Returns:
Return type:bool

New in version NX9.0.0.

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

IsOccurrence

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

IsSimulationObjectGroupAllowed

SimGroupContainer.IsSimulationObjectGroupAllowed

Returns a value indicating whether a simulation object group is allowed for this group container

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

Getter Method

Signature IsSimulationObjectGroupAllowed

Returns:
Return type:bool

New in version NX9.0.0.

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

JournalIdentifier

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

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

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

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

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

CreateConstraintGroup

SimGroupContainer.CreateConstraintGroup

Creates a constraint group for a solution or solution step

Signature CreateConstraintGroup()

Returns:Constraint group CAE.SimConstraintGroup to be created
Return type:NXOpen.CAE.SimConstraintGroup

New in version NX9.0.0.

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

CreateLoadGroup

SimGroupContainer.CreateLoadGroup

Creates a load group for a solution or solution step

Signature CreateLoadGroup()

Returns:Load group CAE.SimLoadGroup to be created
Return type:NXOpen.CAE.SimLoadGroup

New in version NX9.0.0.

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

CreateSimulationObjectGroup

SimGroupContainer.CreateSimulationObjectGroup

Creates a simulation object group for a solution or solution step

Signature CreateSimulationObjectGroup()

Returns:Simulation object group CAE.SimSimulationObjectGroup to be created
Return type:NXOpen.CAE.SimSimulationObjectGroup

New in version NX9.0.0.

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

DeleteGroup

SimGroupContainer.DeleteGroup

Deletes a BC group from this group container

Signature DeleteGroup(lbGroup)

Parameters:lbGroup (NXOpen.CAE.SimBcGroup) – the BC Group CAE.SimBcGroup to be deleted

New in version NX9.0.0.

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

FindObject

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

GetGroupCount

SimGroupContainer.GetGroupCount

Returns the number of groups in this container

Signature GetGroupCount()

Returns:number of groups in the container
Return type:int

New in version NX4.0.0.

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

GetGroups

SimGroupContainer.GetGroups

Gets the BC groups in this group container

Signature GetGroups()

Returns:the groups in the group container
Return type:list of NXOpen.CAE.SimBcGroup

New in version NX9.0.0.

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

Print

SimGroupContainer.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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