Project Types#

Classes used for the Project API.

BoardBounds(bounds)

Contains the properties of the board bounds.

CsvExcelFile(header_row_count, ...)

Contains the properties for a thermal map, CSV, or Excel file.

CsvExcelOutlineFile(**data)

Contains the properties for a CSV or Excel outline file.

GerberOutlineFile(**data)

Contains the properties for a Gerber outline file.

IcepakFile(temperature_offset, ...)

Contains the properties for a thermal map Icepak file.

ImageBounds(image_x, image_y, height, width)

Contains the properties of the image bounds.

ImageFile(board_bounds, coordinate_units, ...)

Contains the properties for a thermal map image file.

LegendBounds(legend_x, legend_y, height, width)

Contains the properties of the legend bounds.

OutlineFile(**data)

Contains the properties for an outline file.

Constants#

class ansys.sherlock.core.types.project_types.LegendOrientation#

Constants for legend orientation in the update thermal maps request.

HORIZONTAL = 0#

Horizontal

VERTICAL = 1#

Vertical

class ansys.sherlock.core.types.project_types.OutlineFileType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)#

Constants for File Type in the Update Outline request.

CSV_EXCEL = 1#

CSV Excel

GERBER = 2#

Gerber

IPC2581 = 3#

IPC2581

class ansys.sherlock.core.types.project_types.StrainMapsFileType#

Constants for File Type in the Add Strain Maps request.

CSV = 0#

CSV

EXCEL = 1#

Excel

IMAGE = 2#

Image

class ansys.sherlock.core.types.project_types.StrainMapLegendOrientation#

Constants for legend orientation in the add strain maps request.

HORIZONTAL = 0#

Horizontal

VERTICAL = 1#

Vertical

class ansys.sherlock.core.types.project_types.ThermalBoardSide#

Constants for thermal board side in the update thermal maps request.

BOTH = 1#

Both

BOTTOM = 0#

Bottom

TOP = 2#

Top

class ansys.sherlock.core.types.project_types.ThermalMapsFileType#

Constants for File Type in the Update Thermal Maps request.

CSV = 0#

CSV

EXCEL = 1#

Excel

IMAGE = 2#

Image

TMAP = 3#

Icepak Thermal Map (.TMAP)