diff --git a/docs/cxx/interface_types.md b/docs/cxx/interface_types.md index 180928593..1f1e4ba5b 100644 --- a/docs/cxx/interface_types.md +++ b/docs/cxx/interface_types.md @@ -1,6 +1,6 @@ # Interface Types -itk-wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/src/core/InterfaceTypes.ts): +ITK-Wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/src/core/InterfaceTypes.ts): - [TextFile](../typescript/interface_types/TextFile) - [BinaryFile](../typescript/interface_types/BinaryFile) @@ -47,11 +47,41 @@ int main(argc, char * argv[]) ```
-
itk::wasm::InputTextStream
A string. To reader this data type in C++, using the resulting std::istream.
+
itk::wasm::InputTextStream
A text stream input. To read this data type in C++, use the resulting std::istream from Get().
+ +
itk::wasm::OutputTextStream
A text stream output. To write to this data type in C++, use the resulting std::ostream from Get().
+ +
itk::wasm::InputBinaryStream
A binary stream input. To read this data type in C++, use the resulting std::istream from Get().
+ +
itk::wasm::OutputBinaryStream
A binary stream output. To write to this data type in C++, use the resulting std::ostream from Get().
+ +
itk::wasm::InputImage<TImage>
An input image of type TImage. To access the image in C++, use Get() to get a pointer to the TImage.
+ +
itk::wasm::OutputImage<TImage>
An output image of type TImage. To set the output image in C++, use Set(image) with a pointer to the TImage.
+ +
itk::wasm::InputMesh<TMesh>
An input mesh of type TMesh. To access the mesh in C++, use Get() to get a pointer to the TMesh.
+ +
itk::wasm::OutputMesh<TMesh>
An output mesh of type TMesh. To set the output mesh in C++, use Set(mesh) with a pointer to the TMesh.
+ +
itk::wasm::InputPointSet<TPointSet>
An input point set of type TPointSet. To access the point set in C++, use Get() to get a pointer to the TPointSet.
+ +
itk::wasm::OutputPointSet<TPointSet>
An output point set of type TPointSet. To set the output point set in C++, use Set(pointSet) with a pointer to the TPointSet.
+ +
itk::wasm::InputPolyData<TPolyData>
An input polydata of type TPolyData. To access the polydata in C++, use Get() to get a pointer to the TPolyData.
+ +
itk::wasm::OutputPolyData<TPolyData>
An output polydata of type TPolyData. To set the output polydata in C++, use Set(polyData) with a pointer to the TPolyData.
+ +
itk::wasm::InputTransform<TTransform>
An input transform of type TTransform. To access the transform in C++, use Get() to get a pointer to the TTransform.
+ +
itk::wasm::OutputTransform<TTransform>
An output transform of type TTransform. To set the output transform in C++, use Set(transform) with a pointer to the TTransform.
+ +
std::string (for files)
File paths for input and output files. Use the type names INPUT_TEXT_FILE, OUTPUT_TEXT_FILE, INPUT_BINARY_FILE, or OUTPUT_BINARY_FILE. The string contains the file path that can be used with standard file I/O operations.
+ +
itk::wasm::InputTextStream (for JSON)
JSON input data. Use the type name INPUT_JSON. To read the JSON data in C++, use the resulting std::istream from Get() and parse the JSON content.
+ +
itk::wasm::OutputTextStream (for JSON)
JSON output data. Use the type name OUTPUT_JSON. To write JSON data in C++, use the resulting std::ostream from Get() and write the JSON content.
-*todo: document remaining CLI11 input and output classes.* - For binding generation, set the `type_name` an the options accordingly. The type names are: - `INPUT_TEXT_FILE` @@ -66,7 +96,11 @@ For binding generation, set the `type_name` an the options accordingly. The type - `OUTPUT_IMAGE` - `INPUT_MESH` - `OUTPUT_MESH` +- `INPUT_POINTSET` +- `OUTPUT_POINTSET` - `INPUT_POLYDATA` - `OUTPUT_POLYDATA` - `INPUT_TRANSFORM` -- `OUTPUT_TRANSFORM` \ No newline at end of file +- `OUTPUT_TRANSFORM` +- `INPUT_JSON` +- `OUTPUT_JSON` \ No newline at end of file