LaminateGlobalLayup Class — NXOpen Python API Reference 12.0.0 documentation

# LaminateGlobalLayup Class

class `NXOpen.CAE.``LaminateGlobalLayup`

  Bases: `NXOpen.NXObject`

  Represent a global layup in the ply based modeling.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ActiveStatus | Returns or sets the global layup active status
FiberOrientationOptions | Returns the fiber orientation options
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 global layup label
Name | Returns or sets the global layup 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.
StackingRecipe | Returns or sets the global layup stacking recipe
Tag | Returns the Tag for this object.
PlyGroups | The list of ply groups associated to global layup

# Methods

Method | Description
--- | ---
AutogroupByMaterials | Create groups for materials
ClearLayup | Removes all the ply groups and plies from the global layup
CreateAttributeIterator | Create an attribute iterator
CreateFiberOrientationOptionsBuilder | Creates a `NXOpen.CAE.LaminateFiberOrientationOptionsBuilder`
CreateLockAngleBuilder | Creates a `NXOpen.CAE.LaminateLockAngleBuilder`
DefineSymPlyidRange | Defines the range of id to be used for symmetric and repeated plies.
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
ExportDrapingDomainAsGroups | Exports draping domain to a group
ExportDrapingResults | Exports draping results to a csv file.
ExportLayup | Export simple layup definition to a csv file.
ExportPliesToFibersim | Exports ply definitions to FiberSim using the hdf5 file format.
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
Information | Display global layup information
Print | Prints a representation of this object to the system log file.
RefreshLinkedGroups | Refresh the global layup linked ply group state
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
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.
UpdateDraping | Compute draping for all the plies under this global layup.

# Enumerations

LaminateGlobalLayupStackingRecipeType Enumeration | Used to specify the stacking recipe of the global layup

# Property Detail

## ActiveStatus

`LaminateGlobalLayup.``ActiveStatus`

  Returns or sets the global layup active status

  `-------------------------------------`

  Getter Method

  Signature `ActiveStatus`

  Returns: | layup active status
  Return type: | bool

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

  `-------------------------------------`

  Setter Method

  Signature `ActiveStatus`

  Parameters: | active (bool) – layup active status

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## FiberOrientationOptions

`LaminateGlobalLayup.``FiberOrientationOptions`

  Returns the fiber orientation options

  `-------------------------------------`

  Getter Method

  Signature `FiberOrientationOptions`

  Returns: | the fiber orientation options
  Return type: | `NXOpen.CAE.LaminateFiberOrientationOptions`

  New in version NX7.5.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## IsOccurrence

`LaminateGlobalLayup.``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

`LaminateGlobalLayup.``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.

## Label

`LaminateGlobalLayup.``Label`

  Returns or sets the global layup label

  `-------------------------------------`

  Getter Method

  Signature `Label`

  Returns: | layup label
  Return type: | int

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

  `-------------------------------------`

  Setter Method

  Signature `Label`

  Parameters: | label (int) – layup label

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## Name

`LaminateGlobalLayup.``Name`

  Returns or sets the global layup name

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: | layup name
  Return type: | str

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) – layup name

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## OwningComponent

`LaminateGlobalLayup.``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

`LaminateGlobalLayup.``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

`LaminateGlobalLayup.``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.

## StackingRecipe

`LaminateGlobalLayup.``StackingRecipe`

  Returns or sets the global layup stacking recipe

  `-------------------------------------`

  Getter Method

  Signature `StackingRecipe`

  Returns: | stacking recipe
  Return type: | `NXOpen.CAE.LaminateGlobalLayupStackingRecipeType`

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

  `-------------------------------------`

  Setter Method

  Signature `StackingRecipe`

  Parameters: | stacinkRecipe (`NXOpen.CAE.LaminateGlobalLayupStackingRecipeType`) – stacking recipe

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## PlyGroups

`LaminateGlobalLayup.``PlyGroups`

  The list of ply groups associated to global layup

  Signature `PlyGroups`

  New in version NX6.0.2.

  Returns: |
  Return type: | `NXOpen.CAE.LaminateGlobalLayupPlyGroupCollection`

# Method Detail

## AutogroupByMaterials

`LaminateGlobalLayup.``AutogroupByMaterials`

  Create groups for materials

  Signature `AutogroupByMaterials()`

  New in version NX9.0.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## ClearLayup

`LaminateGlobalLayup.``ClearLayup`

  Removes all the ply groups and plies from the global layup

  Signature `ClearLayup()`

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## CreateFiberOrientationOptionsBuilder

`LaminateGlobalLayup.``CreateFiberOrientationOptionsBuilder`

  Creates a `NXOpen.CAE.LaminateFiberOrientationOptionsBuilder`

  Signature `CreateFiberOrientationOptionsBuilder()`

  Returns: |
  Return type: | `NXOpen.CAE.LaminateFiberOrientationOptionsBuilder`

  New in version NX7.5.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## CreateLockAngleBuilder

`LaminateGlobalLayup.``CreateLockAngleBuilder`

  Creates a `NXOpen.CAE.LaminateLockAngleBuilder`

  Signature `CreateLockAngleBuilder()`

  Returns: |
  Return type: | `NXOpen.CAE.LaminateLockAngleBuilder`

  New in version NX7.5.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## DefineSymPlyidRange

`LaminateGlobalLayup.``DefineSymPlyidRange`

  Defines the range of id to be used for symmetric and repeated plies.

  Signature `DefineSymPlyidRange(minId, maxId)`

  Parameters:

  - minId (int) – Minimum symmetric ply id, inclusive
  - maxId (int) – Maximum symmetric ply id, exclusive

  New in version NX8.0.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## ExportDrapingDomainAsGroups

`LaminateGlobalLayup.``ExportDrapingDomainAsGroups`

  Exports draping domain to a group

  Signature `ExportDrapingDomainAsGroups(individualPlyGroups)`

  Parameters: | individualPlyGroups (bool) – If true, create one group per ply. If false, put everything in the same group

  New in version NX7.5.2.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## ExportDrapingResults

`LaminateGlobalLayup.``ExportDrapingResults`

  Exports draping results to a csv file.

  Signature `ExportDrapingResults(csvFilename, showShearAngle, showYarnAngle, showPrimaryDirection, showSecondaryDirection, showNormalDirection)`

  Parameters:

  - csvFilename (str) –
  - showShearAngle (bool) –
  - showYarnAngle (bool) –
  - showPrimaryDirection (bool) –
  - showSecondaryDirection (bool) –
  - showNormalDirection (bool) –

  New in version NX7.5.1.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## ExportLayup

`LaminateGlobalLayup.``ExportLayup`

  Export simple layup definition to a csv file.

  Corresponds to the CSV layup export button in the Ply Layup section of the Layup Modeler dialog.

  Signature `ExportLayup(csvFilename)`

  Parameters: | csvFilename (str) –

  New in version NX8.0.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## ExportPliesToFibersim

`LaminateGlobalLayup.``ExportPliesToFibersim`

  Exports ply definitions to FiberSim using the hdf5 file format.

  Signature `ExportPliesToFibersim(filename)`

  Parameters: | filename (str) – File to which the plies will be exported using the FiberSim hdf5 format.

  New in version NX8.0.0.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## FindObject

`LaminateGlobalLayup.``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

`LaminateGlobalLayup.``Information`

  Display global layup information

  Signature `Information(detailed)`

  Parameters: | detailed (bool) –

  New in version NX7.5.1.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

## Print

`LaminateGlobalLayup.``Print`

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

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## RefreshLinkedGroups

`LaminateGlobalLayup.``RefreshLinkedGroups`

  Refresh the global layup linked ply group state

  Signature `RefreshLinkedGroups()`

  New in version NX7.5.0.

  License requirements: nx_lam_composites (“Laminate Composites”)

## UpdateDraping

`LaminateGlobalLayup.``UpdateDraping`

  Compute draping for all the plies under this global layup.

  Plies that are already computed wont be recomputed.

  Signature `UpdateDraping()`

  New in version NX7.5.1.

  License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)