Using a new service is the fastest way to implement a feature for analyzing terrain. In this exercise, you'll learn how to implement and test a new service. The implementation will use a base service library, which will be supported by other Scenome Scripting Language function libraries.
The new service wizard appears. This allows you to specify basic information about your service.
Octopus Software, Inc.AnalyzeTerrainThis service opens a GEOTIFF file, performs terrain analysis, and generates an avalanche terrain analysis report for the elevation data.The software displays a message box that says a script path has been copied to the clipboard.
You'll need to use a text editor that supports multiple documents, or you'll need to start multiple text editors during this exercise.
There will be minor differences in your script and what you see below. For example: the author will be different.
///////////////////////////////////////////////////////////////////////////////
//
// $author Scenomics LLC
// $description This service opens a GEOTIFF file, performs terrain analysis, and generates an avalanche terrain analysis report for the elevation data.
//
// Copyright 2021 Scenomics LLC. All Rights Reserved.
//
///////////////////////////////////////////////////////////////////////////////
library LibAppServiceWorkloadAnalyzeTerrain;
import library "app_service_assert_util.ssl";
import library "app_service_build_util.ssl";
import library "app_service_console_util.ssl";
import library "app_service_main_util.ssl";
import library "type_file_path_algorithms.ssl";
import library "type_float32_array_util.ssl";
import library "type_image_channel_extract_util.ssl";
import library "type_image_format_util.ssl";
import library "type_image_util.ssl";
import library "type_int32_array_util.ssl";
import library "type_render3d_util.ssl";
import library "type_service_enumeration_util.ssl";
import library "type_str_list_util.ssl";
import library "app_service_workload_analyze_terrain_classes.ssl";
///////////////////////////////////////////////////////////////////////////////
// function
///////////////////////////////////////////////////////////////////////////////
function void GetName( Str p_oName )
{
p_oName.Value = "Spa.Service.AnalyzeTerrain";
}
///////////////////////////////////////////////////////////////////////////////
// function
///////////////////////////////////////////////////////////////////////////////
function bool Execute( CommandPresentationModuleInfo commandInfo )
{
auto Str a_oName;
GetName( a_oName );
auto StrList a_slMessages;
LibAppServiceBuild.GenerateServiceHeader(
a_oName.Value, a_slMessages );
a_slMessages.AddBlank();
a_slMessages.Add( "Executed service: " + a_oName.Value );
LibAppServiceBuild.Out( a_slMessages );
return true;
}
The application displays a dialog that allows you to search for application scripts.
app_service_workload_analyze_terrain_classes.sslThe script entry appears in the dialog.
The application copies the script path to the Windows® clipboard.
///////////////////////////////////////////////////////////////////////////////
//
// $author Scenomics LLC
// $description This script contains class declarations.
//
// Copyright 2021 Scenomics LLC. All Rights Reserved.
//
///////////////////////////////////////////////////////////////////////////////
import library "app_service_assert_util.ssl";
import library "app_service_console_util.ssl";
///////////////////////////////////////////////////////////////////////////////
// class
///////////////////////////////////////////////////////////////////////////////
class BuildInputs
{
Model3D m_oModel;
Render3D m_oDevice;
RenderInfo m_oRenderInfo;
int m_eMinGlslVersion;
FileNode m_oData;
string m_sBuildFolder;
StrList m_slMessages;
auto FilePath m_oModelPath;
auto FilePath m_oSourcePath;
auto Int32Vector m_oLens;
int m_iArraySlices;
int m_iMaxBatchSize;
auto GdalImageInfo m_oGdalImageInfo;
auto GdalDataSet m_oGdalDataset;
auto Int32Vector m_viDstRange;
auto Int32Vector m_viMapInfo;
int m_nScaleFactor;
double m_dSpacingX;
double m_dSpacingY;
double m_dRangeX;
double m_dRangeY;
double m_dChunkRangeX;
double m_dChunkRangeY;
auto Float32Array m_afMinMaxElevation;
auto Float32Array m_afMinMaxNormals;
auto FilePath m_oArraysPath;
auto FilePath m_oMapsPath;
auto FilePath m_oAnalysisPath;
auto FilePath m_oImagesPath;
string m_sElevationMapFilePath;
string m_sAspectMapFilePath;
string m_sSlopeMapFilePath;
string m_sOpennessMapFilePath;
};
This class has a variety of data members that are used to store data created during service execution. Note that there is a mix of plain old data such as ints and doubles, and objects declared with and without auto. The first important thing to know is that all object data members are pointers, whether they are declared with auto or not. For a C++ programmer, this means that the data member Model3D m_oModel; is equivalent to Model3D * m_oModel = nullptr;. The declaration auto GdalImageInfo m_oGdalImageInfo; is equivalent to the C++ GdalImageInfo m_oGdalImageInfo;, where you would expect m_oGdalImageInfo to be a live object you can use.
You cannot initialize class members in the class itself. You must first instantiate the class and then you can initialize data members as needed. By default, class members that are plain old data will be zero initialized or initialized to empty, object class members declared without auto will be nullptr initialized, and object class members declared with auto will be initialized to the constructor defaults implemented by the underlying C++ code.
This can seem limiting, but in practice, it works really well. It's worth mentioning that you can use Scenome Scripting Language functions to initialize objects, and if you want to have a custom 'constructor', you could write that function in this library.
Like in C++, when an instance of a class goes out of scope, the destructors of its data members are executed. This means you can use RAII techniques when you write Scenome Scripting Language code, which is very convenient.
///////////////////////////////////////////////////////////////////////////////
// class
///////////////////////////////////////////////////////////////////////////////
class BuildOutputs
{
auto TypeBuffer m_apArrayImages;
auto TypeBuffer m_apMapImages;
Image m_oAngleTiles;
Image m_oSurfaceTiles;
Image m_oSumTiles;
auto TypeBuffer m_apElevationImages;
auto StrList m_slElevationPaths;
auto TypeBuffer m_apSlopeImages;
auto StrList m_slSlopePaths;
auto TypeBuffer m_apOpenImages;
auto StrList m_slOpenPaths;
auto TypeBuffer m_apAspectImages;
auto StrList m_slAspectPaths;
auto TypeBuffer m_apAreaImages;
auto StrList m_slAreaPaths;
auto TypeBuffer m_apAreaImagesFloat;
auto StrList m_slAreaPathsFloat;
auto TypeBuffer m_apSumImages;
auto StrList m_slSumPaths;
auto FilePath m_oReportPath;
};
We'll use an object of type <BuildOutputs> to manage the outputs generated during service execution. We'll store collections of <Image> objects in the <TypeBuffer> data members, and we'll store collections of file paths in the <StrList> objects. The <TypeBuffer> objects will own the <Image> objects, which means the <Image> objects will automatically be destroyed when the instance of <BuildOutputs> goes out of scope at the end of the service execution command.
If there are any script compiler errors, undo your changes in the text editor, go back to the previous step, and follow the instructions again. Here is an example of what error messages might look like:
Start loading scripts
D:\release6\scripts\app_shell_util.ssl(1770) : error: newline in constant
Done loading scripts; 10 loaded in 1.29 ms; avg 0.09
The software displays the service selection dialog:
The service runs and then displays the build log in the output window.
--- <Executing Service 'Spa.Service.AnalyzeTerrain'> ---
Executed service: Spa.Service.AnalyzeTerrain
The service runs correctly. It doesn't do anything, but we'll start the implementation next.