UserParam (ARCTokenization)

UserParam Type

Namespace: ControlledVocabulary
Assembly: ControlledVocabulary.dll
Base Type: CvAttributeCollection
All Interfaces: IDictionary<string, IParam> , ICollection<KeyValuePair<string, IParam>> , IReadOnlyDictionary<string, IParam> , IReadOnlyCollection<KeyValuePair<string, IParam>> , IEnumerable<KeyValuePair<string, IParam>> , IDictionary , ICollection , IEnumerable , IDeserializationCallback , ISerializable , IParam , IParamBase , ICvBase , IAttributeCollection

Represents a structured value, annotated by a user defined name

Constructors

Constructor	Description
`UserParam(name, pv)` Full Usage: `UserParam(name, pv)` Parameters: name : `string` pv : `ParamValue` Returns: `UserParam`	name : `string` pv : `ParamValue` Returns: `UserParam`
`UserParam(name, pv, attributes)` Full Usage: `UserParam(name, pv, attributes)` Parameters: name : `string` pv : `ParamValue` attributes : `IParam seq` Returns: `UserParam`	name : `string` pv : `ParamValue` attributes : `IParam seq` Returns: `UserParam`
`UserParam(name, paramValue, attributes)` Full Usage: `UserParam(name, paramValue, attributes)` Parameters: name : `string` paramValue : `ParamValue` attributes : `IDictionary<string, IParam>` Returns: `UserParam`	name : `string` paramValue : `ParamValue` attributes : `IDictionary<string, IParam>` Returns: `UserParam`

Instance members

Instance member	Description
`this.Accession` Full Usage: `this.Accession` Returns: `string`	Returns: `string`
`this.DisplayText` Full Usage: `this.DisplayText` Returns: `string`	Returns: `string`
`this.HasAttributes` Full Usage: `this.HasAttributes` Returns: `bool`	Returns: `bool`
`this.Name` Full Usage: `this.Name` Returns: `string`	Returns: `string`
`this.RefUri` Full Usage: `this.RefUri` Returns: `string`	Returns: `string`
`this.Value` Full Usage: `this.Value` Returns: `ParamValue`	Returns: `ParamValue`
`this.WithValue` Full Usage: `this.WithValue` Parameters: v : `ParamValue` Returns: `UserParam`	v : `ParamValue` Returns: `UserParam`

Static members

Static member	Description
`UserParam.equals up1 up2` Full Usage: `UserParam.equals up1 up2` Parameters: up1 : `UserParam` up2 : `UserParam` Returns: `bool`	Returns true, if the terms of the given param items match up1 : `UserParam` up2 : `UserParam` Returns: `bool`
`UserParam.equalsName up1 up2` Full Usage: `UserParam.equalsName up1 up2` Parameters: up1 : `UserParam` up2 : `UserParam` Returns: `bool`	Returns true, if the names of the given param items match up1 : `UserParam` up2 : `UserParam` Returns: `bool`
`UserParam.equalsTerm term up` Full Usage: `UserParam.equalsTerm term up` Parameters: term : `CvTerm` up : `UserParam` Returns: `bool`	Returns true, if the given term matches the term of the cv item term : `CvTerm` up : `UserParam` Returns: `bool`
`UserParam.getCvAccession up` Full Usage: `UserParam.getCvAccession up` Parameters: up : `UserParam` Returns: `string`	Returns the id of the cv item up : `UserParam` Returns: `string`
`UserParam.getCvName up` Full Usage: `UserParam.getCvName up` Parameters: up : `UserParam` Returns: `string`	Returns the name of the cv item up : `UserParam` Returns: `string`
`UserParam.getCvRef up` Full Usage: `UserParam.getCvRef up` Parameters: up : `UserParam` Returns: `string`	Returns the reference of the cv item up : `UserParam` Returns: `string`
`UserParam.getParamValue up` Full Usage: `UserParam.getParamValue up` Parameters: up : `UserParam` Returns: `ParamValue`	Returns the value of the Param as a ParamValue up : `UserParam` Returns: `ParamValue`
`UserParam.getTerm up` Full Usage: `UserParam.getTerm up` Parameters: up : `UserParam` Returns: `CvTerm`	Returns the full term of the cv item up : `UserParam` Returns: `CvTerm`
`UserParam.getValue up` Full Usage: `UserParam.getValue up` Parameters: up : `UserParam` Returns: `IConvertible`	Returns the value of the Param as IConvertible up : `UserParam` Returns: `IConvertible`
`UserParam.getValueAsInt up` Full Usage: `UserParam.getValueAsInt up` Parameters: up : `UserParam` Returns: `int`	Returns the value of the Param as int if possible, else fails up : `UserParam` Returns: `int`
`UserParam.getValueAsString up` Full Usage: `UserParam.getValueAsString up` Parameters: up : `UserParam` Returns: `string`	Returns the value of the Param as string up : `UserParam` Returns: `string`
`UserParam.getValueAsTerm up` Full Usage: `UserParam.getValueAsTerm up` Parameters: up : `UserParam` Returns: `CvTerm`	Returns the value of the Param as a term up : `UserParam` Returns: `CvTerm`
`UserParam.mapValue f up` Full Usage: `UserParam.mapValue f up` Parameters: f : `ParamValue -> ParamValue` up : `UserParam` Returns: `CvParam`	f : `ParamValue -> ParamValue` up : `UserParam` Returns: `CvParam`
`UserParam.toCvParam up` Full Usage: `UserParam.toCvParam up` Parameters: up : `UserParam` Returns: `CvParam`	up : `UserParam` Returns: `CvParam`
`UserParam.tryAddAccession acc up` Full Usage: `UserParam.tryAddAccession acc up` Parameters: acc : `string` up : `UserParam` Returns: `UserParam option`	acc : `string` up : `UserParam` Returns: `UserParam option`
`UserParam.tryAddName name up` Full Usage: `UserParam.tryAddName name up` Parameters: name : `string` up : `UserParam` Returns: `UserParam option`	name : `string` up : `UserParam` Returns: `UserParam option`
`UserParam.tryAddReference ref up` Full Usage: `UserParam.tryAddReference ref up` Parameters: ref : `string` up : `UserParam` Returns: `UserParam option`	ref : `string` up : `UserParam` Returns: `UserParam option`
`UserParam.tryAddUnit unit up` Full Usage: `UserParam.tryAddUnit unit up` Parameters: unit : `CvUnit` up : `UserParam` Returns: `UserParam option`	unit : `CvUnit` up : `UserParam` Returns: `UserParam option`
`UserParam.tryGetCvUnit up` Full Usage: `UserParam.tryGetCvUnit up` Parameters: up : `UserParam` Returns: `CvUnit option`	up : `UserParam` Returns: `CvUnit option`
`UserParam.tryGetCvUnitTermAccession up` Full Usage: `UserParam.tryGetCvUnitTermAccession up` Parameters: up : `UserParam` Returns: `string option`	up : `UserParam` Returns: `string option`
`UserParam.tryGetCvUnitTermName up` Full Usage: `UserParam.tryGetCvUnitTermName up` Parameters: up : `UserParam` Returns: `string option`	up : `UserParam` Returns: `string option`
`UserParam.tryGetCvUnitTermRef up` Full Usage: `UserParam.tryGetCvUnitTermRef up` Parameters: up : `UserParam` Returns: `string option`	up : `UserParam` Returns: `string option`
`UserParam.tryGetCvUnitValue up` Full Usage: `UserParam.tryGetCvUnitValue up` Parameters: up : `UserParam` Returns: `IConvertible option`	up : `UserParam` Returns: `IConvertible option`
`UserParam.tryGetValueAccession up` Full Usage: `UserParam.tryGetValueAccession up` Parameters: up : `UserParam` Returns: `string option`	up : `UserParam` Returns: `string option`
`UserParam.tryGetValueRef up` Full Usage: `UserParam.tryGetValueRef up` Parameters: up : `UserParam` Returns: `string option`	up : `UserParam` Returns: `string option`
`UserParam.tryMapValue f up` Full Usage: `UserParam.tryMapValue f up` Parameters: f : `ParamValue -> ParamValue option` up : `UserParam` Returns: `UserParam option`	f : `ParamValue -> ParamValue option` up : `UserParam` Returns: `UserParam option`