Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions 2025R1_Test/sherlock-split-files/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
5 changes: 5 additions & 0 deletions 2025R1_Test/sherlock-split-files/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
2 changes: 2 additions & 0 deletions 2025R1_Test/sherlock-split-files/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
29 changes: 29 additions & 0 deletions 2025R1_Test/sherlock-split-files/articles/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Index to the Sherlock APIs

In the table below, API services are listed alphabetically. Clicking on any of
the links will take you the pertinent section where the API services are
presented in detail. Also, links at the bottom of the table take you to tables
which define [Scalar Value Types](scalar-values.md "gRPC Scalar Value Types").

Table 1.1. Index to the Sherlock APIs

Sherlock APIService| Description|
---|---|
[Analysis Service](analysis-services.md "Sherlock Analysis Service- SherlockAnalysisService.proto") | The APIs in this section allow you to run one or more analyses in sequential order. Results are saved to the project's Saved Results folder on Sherlock Project Tree. `SherlockAnalysisService.proto` |
[Common Service](common-services.md "Sherlock Common Service- SherlockCommonService.proto") | This section contains health checks and exit APIs shared by all services. `SherlockCommonService.proto` |
[Layer Services](layer-services.md "Sherlock Layer Service-SherlockLayerService.proto")| The APIs in this section allow you to perform different layer view operations to a board. `SherlockLayerServices.proto`
[Life Cycle Service](life-cycle-services.md "Sherlock Life Cycle Service- SherlockLifeCycleService.proto") | The APIs in this section return the list of Life Cycle events for a given project as well as allow you to define different Life Cycle events and profiles. `SherlockLifeCycleService.proto`
[Model Service](model-services.md "Sherlock Model Services-SherlockModelServices.proto")| The APIs in this section allows you to export the 3D model, material definitions, and material assignments from Sherlock so they can be shared with other applications such as Ansys Workbench. `SherlockModelService.proto`
[Parts Service](part-services.md "Sherlock Parts Service- SherlockPartsService.proto") | In this section you will find APIs that allow you to see the user-configured part libraries, to see a list of parts with properties different than those in the Sherlock Part Library, and to update the Parts List for a given project.`SherlockPartsService.proto`
[Project Service](project-services.md "Sherlock Project Service- SherlockProjectService.proto") | The APIs in this section perform project level functions such as generating reports and importing ECAD files. `SherlockProjectService.proto`
[Stackup Service](stackup-services.md "Sherlock Stackup Service- SherlockStackupService.proto") | The APIs in this section allow you to perform updates on laminate layers. `SherlockStackupService.proto`
Scalar Value Types: The links below will take you to tables which define gRPC scalar values by language type. | For C++, Java, Python, and Go, [click here](scalar-values.md#sherlock_ug_table_gRPC_scalar_C_plus_java "Table 1.238. gRPC Scalar Value Types \(A\)").
---
For C#, PHP, and Ruby, [click here](scalar-values.md#sherlock_ug_table_gRPC_scalar_Types_B "Table 1.239. gRPC Scalar Value Types \(B\)").



* * *

[Prev](index.md) / [Next](analysis-services.md)

20 changes: 20 additions & 0 deletions 2025R1_Test/sherlock-split-files/articles/Scalar_Value_Types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Scalar Value Types

| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |

Loading