ShapeValidationInfo Class Reference

Provides information about validation of a single shapefile before or after certain operation. More...

Collaboration diagram for ShapeValidationInfo:
Collaboration graph

Properties

string ClassName [get]
 Gets name of the class geoprocessing method was an from. More...
 
int FixedCount [get]
 Gets number of errors that were fixed, i.e. invalid shapes were substituted with fixed ones. More...
 
bool IsValid [get]
 Get a value indicating whether the input or output was finally considered valid (probably after fixing invalid shapes). More...
 
string MethodName [get]
 Gets the name of geoprocessing methods that was validated. More...
 
string ParameterName [get]
 Gets the name of parameter of geoprocessing methods that was validated. More...
 
int SkippedCount [get]
 Gets number of invalid shapes that were skipped during validation (i.e. input shapes not processed at all or output shapes excluded from output). More...
 
tkShapeValidationStatus Status [get]
 Gets status of validation operation. More...
 
int StillInvalidCount [get]
 Gets number of shape that were still invalid after possible attempts to fix them. More...
 
tkShapeValidationMode ValidationMode [get]
 Gets validation mode that was used. More...
 
tkShapeValidationType ValidationType [get]
 Gets a value indicating whether it was input or output validation. More...
 
bool WasValidated [get]
 Gets a value indicating whether validation was performed . More...
 
int WereInvalidCount [get]
 Gets number of shapes that were initially invalid. Depending on validation mode they might be fixed. More...
 

Detailed Description

Provides information about validation of a single shapefile before or after certain operation.

New API 4.9.1:
Added in version 4.9.1

Property Documentation

◆ ClassName

string ShapeValidationInfo.ClassName
get

Gets name of the class geoprocessing method was an from.

◆ FixedCount

int ShapeValidationInfo.FixedCount
get

Gets number of errors that were fixed, i.e. invalid shapes were substituted with fixed ones.

◆ IsValid

bool ShapeValidationInfo.IsValid
get

Get a value indicating whether the input or output was finally considered valid (probably after fixing invalid shapes).

◆ MethodName

string ShapeValidationInfo.MethodName
get

Gets the name of geoprocessing methods that was validated.

◆ ParameterName

string ShapeValidationInfo.ParameterName
get

Gets the name of parameter of geoprocessing methods that was validated.

Only parameters of Shapefile type are validated. "this" will be returned in case shapefile object itself from which the method was ran was validated.

◆ SkippedCount

int ShapeValidationInfo.SkippedCount
get

Gets number of invalid shapes that were skipped during validation (i.e. input shapes not processed at all or output shapes excluded from output).

◆ Status

tkShapeValidationStatus ShapeValidationInfo.Status
get

Gets status of validation operation.

◆ StillInvalidCount

int ShapeValidationInfo.StillInvalidCount
get

Gets number of shape that were still invalid after possible attempts to fix them.

◆ ValidationMode

tkShapeValidationMode ShapeValidationInfo.ValidationMode
get

Gets validation mode that was used.

The mode can be changed in GlobalSettings.ShapeInputValidationMode and GlobalSettings.ShapeOutputValidationMode

◆ ValidationType

tkShapeValidationType ShapeValidationInfo.ValidationType
get

Gets a value indicating whether it was input or output validation.

◆ WasValidated

bool ShapeValidationInfo.WasValidated
get

Gets a value indicating whether validation was performed .

I.e. whether ValidationMode was set to something other than NoValidation.

◆ WereInvalidCount

int ShapeValidationInfo.WereInvalidCount
get

Gets number of shapes that were initially invalid. Depending on validation mode they might be fixed.