Class: GoCloseTools

GoCloseTools

Interaction to call a hydraulic tool that lets you know which pipes and which valves you must act on to close the service in a preselected pipe:

new GoCloseTools(pipeId, tablePipe, tableValve, userStylePipes, userStyleValve, APP_ROOT_URL)

Interactions/Hydraulics/interact/CloseTool/index.ts, line 81

Name	Type	Description
`pipeId`	String	The id from a preselected pipe.From this pipe the geospatial calculation will begin
`tablePipe`	String	The Pipe database table name.
`tableValve`	String	The Valve database table name.
`userStylePipes`	module:types~styleFromUser	optional The style we want to put on the Pipes layer
`userStyleValve`	module:types~styleFromUser	The style we want to put on the Valves drawing layer
`APP_ROOT_URL`	String	default "http://localhost:5000"

Properties:

Name	Type	Description
`closeLayerValves`	VectorLayer \| undefined	Private
`closeLayerPipes`	VectorLayer \| undefined	Private
`styleValve`	Style \| undefined	Private
`stylePipe`	Style \| undefined \| Array.<Style>	Private
`servicePipes`	GeoJSON \| undefined	Private
`serviceValves`	GeoJSON \| undefined	Private
`paramsService`	types.closeToolParams	Private
`dataPipe`	Array.<String> \| types.dataRestGeo	Private
`dataValve`	Array.<String> \| types.dataRestGeo	Private
`userStylePipes`	types.styleFromUser
`userStyleValve`	unknown
`dataPipesNames`	Array.<string>
`dataValvesNames`	Array.<string>
`pipeLayerName`	string
`svgIcon`	String	Private

Methods

changeStyleValve(userStyle) Interactions/Hydraulics/interact/CloseTool/index.ts, line 218

Change Valve style layer

Name	Type	Description
`userStyle`	module:types~styleFromUser	User Style to the feature

clearFeatures(){void} Interactions/Hydraulics/interact/CloseTool/index.ts, line 276

Clear both Layers Pipes and Valves

Returns:

Type	Description
void	Return nothing

clearFeaturesPipes(){void} Interactions/Hydraulics/interact/CloseTool/index.ts, line 295

Clear Pipe Layer

Returns:

Type	Description
void	Return nothing

clearFeaturesValve(){void} Interactions/Hydraulics/interact/CloseTool/index.ts, line 286

Clear Valve Layer

Returns:

Type	Description
void	Return nothing

asyncgetCloseToolService(APP_ROOT_URL, paramsService, userStylePipes, userStyleValve) Interactions/Hydraulics/interact/CloseTool/index.ts, line 368

Get the information from geoespatial Tool

Name	Type	Description
`APP_ROOT_URL`	String	default "http://localhost:5000"
`paramsService`	module:types~closeToolParams	User Style to the feature
`userStylePipes`	module:types~styleFromUser	optional User Style to the Pipe layer
`userStyleValve`	module:types~styleFromUser	optional User Style to the Valve layer

getDataClose(idPipe, pipeName, noStudyValve){CancelablePromise.<void>} Interactions/Hydraulics/interact/CloseTool/index.ts, line 232

Get the data of the close

Name	Type	Description
`idPipe`	number	The id from a preselected pipe.From this pipe the geospatial calculation will begin
`pipeName`	String	Name os Layer Pipe
`noStudyValve`	Array.<integer>	in this parameter we need to specify which valves [id] we do not want to enter the study of the closed

Returns:

Type	Description
CancelablePromise.<void>	Return CancelablePromise

getLayerParams(userStyle) Interactions/Hydraulics/interact/CloseTool/index.ts, line 421

Change Valve style layer

Name	Type	Description
`userStyle`	module:types~styleFromUser	User Style to the feature

getLayerPipes(){VectorLayer} Interactions/Hydraulics/interact/CloseTool/index.ts, line 267

Get Pipe layer

Returns:

Type	Description
VectorLayer	Return Vector layer

getLayerValves(){VectorLayer} Interactions/Hydraulics/interact/CloseTool/index.ts, line 259

Get Valve layer

Returns:

Type	Description
VectorLayer	Return Vector layer

refreshCloseTool(){void} Interactions/Hydraulics/interact/CloseTool/index.ts, line 348

Refresh the close tool

Returns:

Type	Description
void	Return nothing

setDefaultStyle(){void} Interactions/Hydraulics/interact/CloseTool/index.ts, line 327

Set the default style for pipes

Returns:

Type	Description
void	Return nothing

setSVGIcon(svgUser){module:types~Style} Interactions/Hydraulics/interact/CloseTool/index.ts, line 306

Set svgs icons

Name	Type	Description
`svgUser`	module:types~ISVGIcon	User svg icon

Returns:

Type	Description
module:types~Style	Return the style