Files

changeWorkingDir(NewDir)

Change the working directory of current document

Alias: workingDir
Parameters:

NewDir (Path) – New directory.

closeDocument()

Close: Close the active model

copyEntities(entity)

Copy: Make a copy of the entity

Parameters:

entity ([Entity]) – Entity/Entities to apply the command

Return type:

Return a list of duplicated entities generated

deleteEntities(entity)

Delete: Delete the entity

Parameters:

entity ([Entity]) – Entity/Entities to apply the command

EntitiesReport(ContainerType)

Creates an entities report object

Constraints: User interface
Parameters:

ContainerType (str) – Container type.

exportAll(FilePath)

Export geometry…: Exports all the geometry to an external file

Parameters:

FilePath (Path) – FileName: File name (igs, iges, stp, step, x_t or dxf extensions).

exportAll(FilePath, Override)

Export geometry…: Exports all the geometry to an external file

Parameters:

  • FilePath (Path) – FileName: File name (igs, iges, stp, step, x_t or dxf extensions).

  • Override (bool) – Set to true to override the file if it exists, without warning.

exportSelect(entity, FilePath)

Export selected…: Exports the selected geometry to an external file

Parameters:

  • entity ([Entity]) – Entity/Entities to apply the command

  • FilePath (Path) – FileName: File name (igs, iges, stp, step, x_t or dxf extensions).

exportSelect(entity, FilePath, Override)

Export selected…: Exports the selected geometry to an external file

Parameters:

  • entity ([Entity]) – Entity/Entities to apply the command

  • FilePath (Path) – FileName: File name (igs, iges, stp, step, x_t or dxf extensions).

  • Override (bool) – Set to true to override the file if it exists, without warning.

GetScriptReport()

Obtains the script report in use

Constraints: User interface
ImageReport(ImgPath)

Creates an image report object

Constraints: User interface
Parameters:

ImgPath (str) – Path to the image file to add.

importFromDoc(FilePath, KCoordSystemsContainer, GeometryContainer, MaterialsContainer, SectionsContainer, StructuralElementsContainer, ModelUtilsContainer, ContactsContainer, LoadGroupsContainer, BCGroupsContainer, InitialConditionGroupsContainer)

Import model…: Import an existing model

Constraints: User interface
Parameters:

  • FilePath (Path) – File to import.

  • KCoordSystemsContainer (bool) – Coordinate systems.

  • GeometryContainer (bool) – Geometry.

  • MaterialsContainer (bool) – Materials.

  • SectionsContainer (bool) – Sections.

  • StructuralElementsContainer (bool) – Structural elements.

  • ModelUtilsContainer (bool) – Model utils.

  • ContactsContainer (bool) – Contacts.

  • LoadGroupsContainer (bool) – Load groups.

  • BCGroupsContainer (bool) – Boundary conditions.

  • InitialConditionGroupsContainer (bool) – Initial Conditions.

importGeom(FilePath)

Import geometry…: Imports the geometry from an external file

Parameters:

FilePath (Path) – FileName: File name (igs, iges, stp, step, x_t or dxf extensions).

newDocument(Dimension, Time, Discipline)

New: Create a new model

Alias: newDoc
Parameters:

  • Enumerate – { Dim2D, Dim3D } Dimension: Dimension.

  • Enumerate – { Static, Transient, Modal, Harmonic, Buckling } Time: Time analysis.

  • Enumerate – { Structural, Seepage, Thermal, AirportPavement } Discipline: Kind of discipline.

openDocument(Path)

Open…: Open an existing model

Parameters:

Path (Path) – Path to the document (xcf or cf extension).

PageBreakReport()

Creates a page break report object

Constraints: User interface
ResultsReport()

Creates an results report object

Constraints: User interface
saveDocument()

Save: Save the active model

Alias: save
saveDocumentAs(Path)

Save as…: Save the active model with a new name

Alias: saveAs
Parameters:

Path (Path) – Path to the document (xcf or cf extension).

saveDocumentAs(Path, Override)

Save as…: Save the active model with a new name

Alias: saveAs
Parameters:

  • Path (Path) – Path to the document (xcf or cf extension).

  • Override (bool) – Set to true to override the file if it exists, without warning.