Share via


Param Class

Definition

A Param with self-contained documentation and optionally default value.

A Param references an individual parameter that includes documentation, the name of the parameter and optionally a default value. Params can either be set using the generic Param methods or by using explicit methods. For example Bucketizer has SetHandleInvalid or you can call GetParam("handleInvalid")and then Bucketizer. Set using the Param and the value you want to use.

public class Param
type Param = class
Public Class Param
Inheritance
Param

Constructors

Param(Identifiable, String, String)

Creates a new instance of a Param which will be attached to the parent specified. The most likely use case for a Param is being read from a parent object such as Bucketizer rather than independently

Param(String, String, String)

Creates a new instance of a Param which will be attached to the parent with the UID specified. The most likely use case for a Param is being read from a parent object such as Bucketizer rather than independently

Properties

Doc

The description of what the Param does and how it works including any defaults and the current value

Name

The name of the Param

Parent

The object that contains the Param

Applies to