SimBCBuilder Class¶
-
class
NXOpen.CAE.SimBCBuilder¶ Bases:
NXOpen.NXObjectThis is a manager to the
CAE.SimBCclass. Objects of typeCAE.SimBCcan be created and edited only through this classNew in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| Bc | Returns the CAE.SimBC object |
| BcLabel | Returns or sets the label of CAE.SimBC object |
| BcName | Returns or sets the name of CAE.SimBC object |
| DestinationFolder | Returns or sets the destination folder of CAE.SimBC object |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| 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 |
| PropertyTable | Returns the property table for the CAE.SimBC object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Tag | Returns the Tag for this object. |
| TargetSetManager | Returns the target set manager for CAE.SimBC object |
Methods¶
| Method | Description |
|---|---|
| CommitAddBc | Commits the creation of the CAE.SimBC objects or Commits the changes made to the CAE.SimBC and adds the BC to the current active solution/step |
| CommitBc | Commits the creation of the CAE.SimBC objects or Commits the changes made to the CAE.SimBC |
| 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 |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| 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 |
| 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¶
Bc¶
-
SimBCBuilder.Bc¶ Returns the
CAE.SimBCobject-------------------------------------Getter Method
Signature
BcReturns: boundary condition Return type: NXOpen.CAE.SimBCNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
BcLabel¶
-
SimBCBuilder.BcLabel¶ Returns or sets the label of
CAE.SimBCobject-------------------------------------Getter Method
Signature
BcLabelReturns: label of the bc Return type: int New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
BcLabelParameters: label (int) – label of the bc New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
BcName¶
-
SimBCBuilder.BcName¶ Returns or sets the name of
CAE.SimBCobject-------------------------------------Getter Method
Signature
BcNameReturns: name of the bc Return type: str New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
BcNameParameters: name (str) – name of the bc New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
DestinationFolder¶
-
SimBCBuilder.DestinationFolder¶ Returns or sets the destination folder of
CAE.SimBCobject-------------------------------------Getter Method
Signature
DestinationFolderReturns: destination folder Return type: NXOpen.CAE.SimLbcFolderNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
DestinationFolderParameters: folder ( NXOpen.CAE.SimLbcFolder) – destination folderNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IsOccurrence¶
-
SimBCBuilder.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
SimBCBuilder.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
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
SimBCBuilder.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
SimBCBuilder.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
SimBCBuilder.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
PropertyTable¶
-
SimBCBuilder.PropertyTable¶ Returns the property table for the
CAE.SimBCobject-------------------------------------Getter Method
Signature
PropertyTableReturns: property table Return type: NXOpen.CAE.PropertyTableNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Prototype¶
-
SimBCBuilder.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
TargetSetManager¶
-
SimBCBuilder.TargetSetManager¶ Returns the target set manager for
CAE.SimBCobject-------------------------------------Getter Method
Signature
TargetSetManagerReturns: target set manager Return type: NXOpen.CAE.SetManagerNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
CommitAddBc¶
-
SimBCBuilder.CommitAddBc¶ Commits the creation of the
CAE.SimBCobjects or Commits the changes made to theCAE.SimBCand adds the BC to the current active solution/stepSignature
CommitAddBc()Returns: boundary condition Return type: NXOpen.CAE.SimBCNew in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CommitBc¶
-
SimBCBuilder.CommitBc¶ Commits the creation of the
CAE.SimBCobjects or Commits the changes made to theCAE.SimBCSignature
CommitBc()Returns: Return type: NXOpen.CAE.SimBCNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Destroy¶
-
SimBCBuilder.Destroy¶ Deletes the builder, and cleans up any objects created by the builder.
This method should always be called when create/edit of the BC object is completed
Signature
Destroy()New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
FindObject¶
-
SimBCBuilder.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
Print¶
-
SimBCBuilder.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
SimBCBuilder.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.