add_outline_file

Project.add_outline_file(request)

Add outline files to a Sherlock project.

Available Since: 2025R2

Parameters:

requestAddOutlineFileRequest

Contains the information needed to add an outline file to a Sherlock project.

Returns:

:

list[SherlockCommonService_pb2.ReturnCode]

Return codes for each request.

Return type:

list[ReturnCode]

Examples

>>> from ansys.sherlock.core.types.project_types import AddOutlineFileRequest
>>> from ansys.sherlock.core.types.project_types import CsvExcelOutlineFile
>>> from ansys.sherlock.core.types.project_types import OutlineFile
>>> from ansys.sherlock.core.types.project_types import OutlineFileType
>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> responses = sherlock.project.add_outline_file(
>>>     AddOutlineFileRequest(
>>>         project="TestProject",
>>>         outline_files = [
>>>             OutlineFile(
>>>                 cca_names=["TestCCA"],
>>>                 file_name="path/to/outline.csv",
>>>                 file_type=OutlineFileType.CSV_EXCEL,
>>>                 outline_file_data=CsvExcelOutlineFile(
>>>                     header_row_count=0,
>>>                     location_units="mm",
>>>                     x_location_column="X",
>>>                     y_location_column="Y",
>>>                 )
>>>             )
>>>         ]
>>>     )
>>> )