Folder Class

class NXOpen.CAE.Connections.Folder

Bases: NXOpen.NXObject

The Folder class offers a way to create a hierarchy of connections and sub-folders

To obtain an instance of this object use the add_folder creator in a parent folder or access connection root folder from CAE.IFEModel

New in version NX12.0.0.

Properties

Property Description
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
Parent Returns the parent folder
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.
ConnectionUtils Returns a CAE.Connections.Utils instance

Methods

Method Description
AddFolder Add a subfolder to this folder.
CreateAttributeIterator Create an attribute iterator
CreateConnection Create a CAE.Connections.IConnection in this folder of the specified type with the specified name
CreateFolder Creates a CAE.Connections.Folder in this folder with the specified name
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.
GetAllConnections Get all the connections under this folder and its descendant folders
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetChildFolders Get the child folders
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetConnections Get the connections
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
ImportConnectionsFromMcf Create CAE.Connections.IConnection connections in the current CAE.Connections.Folder using connection data imported from a MCF file.
ImportSpotWeldFromWcd Create CAE.Connections.SpotWeld connections in the current CAE.Connections.Folder using connection data imported from a WCD file.
MoveConnectionToThisFolder Add a connection to this folder.
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

IsOccurrence

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

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

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

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

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

Parent

Folder.Parent

Returns the parent folder

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

Getter Method

Signature Parent

Returns:parent folder
Return type:NXOpen.CAE.Connections.Folder

New in version NX12.0.0.

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

Prototype

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

ConnectionUtils

Folder.ConnectionUtils

Returns a CAE.Connections.Utils instance

Signature ConnectionUtils

New in version NX12.0.0.

Returns:
Return type:NXOpen.CAE.Connections.Utils

Method Detail

AddFolder

Folder.AddFolder

Add a subfolder to this folder.

The subfolder is moved if found in other folder.

Signature AddFolder(subfolder)

Parameters:subfolder (NXOpen.CAE.Connections.Folder) – the added folder

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

CreateConnection

Folder.CreateConnection

Create a CAE.Connections.IConnection in this folder of the specified type with the specified name

Signature CreateConnection(type, name)

Parameters:
Returns:

the created connection
Return type:

NXOpen.CAE.Connections.IConnection

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

CreateFolder

Folder.CreateFolder

Creates a CAE.Connections.Folder in this folder with the specified name

Signature CreateFolder(name)

Parameters:name (str) – Name that the created folder should have
Returns:the created CAE.Connections.Folder
Return type:NXOpen.CAE.Connections.Folder

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

FindObject

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

GetAllConnections

Folder.GetAllConnections

Get all the connections under this folder and its descendant folders

Signature GetAllConnections()

Returns:all connections under this folder and its descendants
Return type:list of NXOpen.CAE.Connections.IConnection

New in version NX12.0.0.

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

GetChildFolders

Folder.GetChildFolders

Get the child folders

Signature GetChildFolders()

Returns:child folders
Return type:list of NXOpen.CAE.Connections.Folder

New in version NX12.0.0.

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

GetConnections

Folder.GetConnections

Get the connections

Signature GetConnections()

Returns:connections found in folder
Return type:list of NXOpen.CAE.Connections.IConnection

New in version NX12.0.0.

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

ImportConnectionsFromMcf

Folder.ImportConnectionsFromMcf

Create CAE.Connections.IConnection connections in the current CAE.Connections.Folder using connection data imported from a MCF file.

Signature ImportConnectionsFromMcf(file, inputFileUnit)

Parameters:
  • file (str) – name of the import file
  • inputFileUnit (NXOpen.Unit) – the length unit used in the input file
Returns:

the created connections
Return type:

list of NXOpen.CAE.Connections.IConnection

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

ImportSpotWeldFromWcd

Folder.ImportSpotWeldFromWcd

Create CAE.Connections.SpotWeld connections in the current CAE.Connections.Folder using connection data imported from a WCD file.

Signature ImportSpotWeldFromWcd(file, inputFileUnit)

Parameters:
  • file (str) – name of the import file
  • inputFileUnit (NXOpen.Unit) – the length unit used in the input file
Returns:

the created connections
Return type:

list of NXOpen.CAE.Connections.SpotWeld

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

MoveConnectionToThisFolder

Folder.MoveConnectionToThisFolder

Add a connection to this folder.

The connection is removed from previous parent folder.

Signature MoveConnectionToThisFolder(connection)

Parameters:connection (NXOpen.CAE.Connections.IConnection) – the connection that is moved

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Print

Folder.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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