python.tools.validators Namespace Reference

Classes
class	activeScriptsValidatorClass
class	cfgValidatorClass
class	DefaultValue
class	EstimatorClass
class	infilepairsValidatorClass
class	infileValidatorClass
class	InputAction
class	mandatory_argument
	workaround before python 3.10 to solve inheritance issues , namely non-default arguments following default arguments. More...
class	MaskFeature
class	maskValidatorClass
class	mosaicStatValidatorClass
class	outfileValidatorClass
class	output_parameter
class	output_parameterValidatorClass
class	ParameterDescription
	Documentation class for a brief and detailed description of a function. More...
class	paramOrigin
class	processorValidatorClass
class	projectDirValidatorClass
class	tempdirValidatorClass
class	TestAnnotation
class	ValidatorBaseClass

Functions
def	get_type_hints_inc_extras (clr)
def	is_annotated (obj)
def	textfileinput (inp, filedir, supportFilter)
def	findfile (f, fdir)
	"searches filedir for a certain strip file or odm file, returns boolean
def	standardinput (inp)
	analyzes non-textfile inputs including wildcards; returns filelist
def	settings_textfile_reader (txtfile, prjdir, allscripts)
	reads settings-textfile and returns the settings for each subscript
def	get_allowed_types (type_)
def	Boolean_val_trafo (val)
def	rigid_type_check (allowed_types, val)
def	autoconversion_type_check (allowed_type, val)
def	GenericValidator (param, val, type_, nargs, clInst)
def	replaceOpalsRoot (p)
def	as_int (value)
def	check_mandatory_argument (clr, clInst, param)
def	check_output_parameter (clr, clInst, param)
def	generic_validation (clr, clInst, param)
def	collect_custom_validator (clr, clInst, param)
def	validate_custom_validators (clr, clInst, customValidators)
def	pre_run_type_check (clr, clInst)
def	validateInput (clr, clInst)
def	set_cfg_arguments (clr, clInst, cfgFile=None, paramOriginDict=None)
	This funciton sets cfg arguments only if the user did not set them using python. More...
def	add_all_arguments (clr, parser, deactivate_mandatory_arguments=False, cfgDefaultValues=dict())
def	get_dest (obj)
def	get_choices (obj)
def	get_validator (obj)
def	get_validationErrorText (obj)
def	get_estimate (obj)
def	get_type (obj)
def	get_brief (obj)
def	get_help (obj)
def	get_description (obj)
def	get_argument_group (obj)
def	is_mandatory (cls, param)
def	get_default_value (cls, param)
def	get_nrofargs_and_arg_type (paramDescriptionType)

Variables
list	extensions = ["wnp", "bwnp", "xyz", "bxyz", "las", "sdw", "fwf", ".tif", ".dtm", ".asc", "dem", "hgt", "bil", "flt"]

Detailed Description

reads textfile and returns filelist, pairs

Function Documentation

set_cfg_arguments()

def python.tools.validators.set_cfg_arguments	(		clr,
			clInst,
			cfgFile = None,
			paramOriginDict = None
	)

This funciton sets cfg arguments only if the user did not set them using python.

This is done via a check if the value is still the default value or not.