CvParam (ARCTokenization)

CvParam 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 with a controlled vocabulary term Attributes can be used to further describe the CvParam

Constructors

Constructor	Description
`CvParam(cvTerm, v)` Full Usage: `CvParam(cvTerm, v)` Parameters: cvTerm : `CvTerm` v : `IConvertible` Returns: `CvParam`	cvTerm : `CvTerm` v : `IConvertible` Returns: `CvParam`
`CvParam(cvTerm, pv)` Full Usage: `CvParam(cvTerm, pv)` Parameters: cvTerm : `CvTerm` pv : `ParamValue` Returns: `CvParam`	cvTerm : `CvTerm` pv : `ParamValue` Returns: `CvParam`
`CvParam(term, pv, attributes)` Full Usage: `CvParam(term, pv, attributes)` Parameters: term : `CvTerm` pv : `ParamValue` attributes : `IParam seq` Returns: `CvParam`	term : `CvTerm` pv : `ParamValue` attributes : `IParam seq` Returns: `CvParam`
`CvParam(id, name, ref, v)` Full Usage: `CvParam(id, name, ref, v)` Parameters: id : `string` name : `string` ref : `string` v : `IConvertible` Returns: `CvParam`	id : `string` name : `string` ref : `string` v : `IConvertible` Returns: `CvParam`
`CvParam(id, name, ref, pv)` Full Usage: `CvParam(id, name, ref, pv)` Parameters: id : `string` name : `string` ref : `string` pv : `ParamValue` Returns: `CvParam`	id : `string` name : `string` ref : `string` pv : `ParamValue` Returns: `CvParam`
`CvParam(id, name, ref, pv, attributes)` Full Usage: `CvParam(id, name, ref, pv, attributes)` Parameters: id : `string` name : `string` ref : `string` pv : `ParamValue` attributes : `IParam seq` Returns: `CvParam`	id : `string` name : `string` ref : `string` pv : `ParamValue` attributes : `IParam seq` Returns: `CvParam`
`CvParam(cvAccession, cvName, cvRef, paramValue, attributes)` Full Usage: `CvParam(cvAccession, cvName, cvRef, paramValue, attributes)` Parameters: cvAccession : `string` cvName : `string` cvRef : `string` paramValue : `ParamValue` attributes : `IDictionary<string, IParam>` Returns: `CvParam`	cvAccession : `string` cvName : `string` cvRef : `string` paramValue : `ParamValue` attributes : `IDictionary<string, IParam>` Returns: `CvParam`

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: `CvParam`	v : `ParamValue` Returns: `CvParam`

Static members

Static member	Description
`CvParam.equals cvp1 cvp2` Full Usage: `CvParam.equals cvp1 cvp2` Parameters: cvp1 : `CvParam` cvp2 : `CvParam` Returns: `bool`	Returns true, if the terms of the given param items match cvp1 : `CvParam` cvp2 : `CvParam` Returns: `bool`
`CvParam.equalsName cvp1 cvp2` Full Usage: `CvParam.equalsName cvp1 cvp2` Parameters: cvp1 : `CvParam` cvp2 : `CvParam` Returns: `bool`	Returns true, if the names of the given param items match cvp1 : `CvParam` cvp2 : `CvParam` Returns: `bool`
`CvParam.equalsTerm term cvp` Full Usage: `CvParam.equalsTerm term cvp` Parameters: term : `CvTerm` cvp : `CvParam` Returns: `bool`	Returns true, if the given term matches the term of the cv item term : `CvTerm` cvp : `CvParam` Returns: `bool`
`CvParam.fromCategory category term` Full Usage: `CvParam.fromCategory category term` Parameters: category : `CvTerm` term : `CvTerm` Returns: `CvParam`	Creates a CvParam from a category and a value coming from a controlled vocabulary. category : `CvTerm` term : `CvTerm` Returns: `CvParam`
`CvParam.fromValue category v` Full Usage: `CvParam.fromValue category v` Parameters: category : `CvTerm` v : `'T` Returns: `CvParam`	Create a CvParam from a category and a simple value category : `CvTerm` v : `'T` Returns: `CvParam`
`CvParam.fromValueWithUnit category v unit` Full Usage: `CvParam.fromValueWithUnit category v unit` Parameters: category : `CvTerm` v : `'T` unit : `CvUnit` Returns: `CvParam`	Creates a CvParam from a category, a simple value and a unit coming from a controlled vocabulary. category : `CvTerm` v : `'T` unit : `CvUnit` Returns: `CvParam`
`CvParam.getAttributes param` Full Usage: `CvParam.getAttributes param` Parameters: param : `CvParam` Returns: `'a seq`	param : `CvParam` Returns: `'a seq`
`CvParam.getCvAccession cvp` Full Usage: `CvParam.getCvAccession cvp` Parameters: cvp : `CvParam` Returns: `string`	Returns the id of the cv item cvp : `CvParam` Returns: `string`
`CvParam.getCvName cvp` Full Usage: `CvParam.getCvName cvp` Parameters: cvp : `CvParam` Returns: `string`	Returns the name of the cv item cvp : `CvParam` Returns: `string`
`CvParam.getCvRef cvp` Full Usage: `CvParam.getCvRef cvp` Parameters: cvp : `CvParam` Returns: `string`	Returns the reference of the cv item cvp : `CvParam` Returns: `string`
`CvParam.getParamValue cvp` Full Usage: `CvParam.getParamValue cvp` Parameters: cvp : `CvParam` Returns: `ParamValue`	Returns the value of the Param as a ParamValue cvp : `CvParam` Returns: `ParamValue`
`CvParam.getTerm cvp` Full Usage: `CvParam.getTerm cvp` Parameters: cvp : `CvParam` Returns: `CvTerm`	Returns the full term of the cv item cvp : `CvParam` Returns: `CvTerm`
`CvParam.getValue cvp` Full Usage: `CvParam.getValue cvp` Parameters: cvp : `CvParam` Returns: `IConvertible`	Returns the value of the Param as IConvertible cvp : `CvParam` Returns: `IConvertible`
`CvParam.getValueAsInt cvp` Full Usage: `CvParam.getValueAsInt cvp` Parameters: cvp : `CvParam` Returns: `int`	Returns the value of the Param as int if possible, else fails cvp : `CvParam` Returns: `int`
`CvParam.getValueAsString cvp` Full Usage: `CvParam.getValueAsString cvp` Parameters: cvp : `CvParam` Returns: `string`	Returns the value of the Param as string cvp : `CvParam` Returns: `string`
`CvParam.getValueAsTerm cvp` Full Usage: `CvParam.getValueAsTerm cvp` Parameters: cvp : `CvParam` Returns: `CvTerm`	Returns the value of the Param as a term cvp : `CvParam` Returns: `CvTerm`
`CvParam.mapValue f cvp` Full Usage: `CvParam.mapValue f cvp` Parameters: f : `ParamValue -> ParamValue` cvp : `CvParam` Returns: `CvParam`	f : `ParamValue -> ParamValue` cvp : `CvParam` Returns: `CvParam`
`CvParam.tryAddAccession acc cvp` Full Usage: `CvParam.tryAddAccession acc cvp` Parameters: acc : `string` cvp : `CvParam` Returns: `CvParam option`	acc : `string` cvp : `CvParam` Returns: `CvParam option`
`CvParam.tryAddName name cvp` Full Usage: `CvParam.tryAddName name cvp` Parameters: name : `string` cvp : `CvParam` Returns: `CvParam option`	name : `string` cvp : `CvParam` Returns: `CvParam option`
`CvParam.tryAddReference ref cvp` Full Usage: `CvParam.tryAddReference ref cvp` Parameters: ref : `string` cvp : `CvParam` Returns: `CvParam option`	ref : `string` cvp : `CvParam` Returns: `CvParam option`
`CvParam.tryAddUnit unit cvp` Full Usage: `CvParam.tryAddUnit unit cvp` Parameters: unit : `CvUnit` cvp : `CvParam` Returns: `CvParam option`	unit : `CvUnit` cvp : `CvParam` Returns: `CvParam option`
`CvParam.tryGetCvUnit cvp` Full Usage: `CvParam.tryGetCvUnit cvp` Parameters: cvp : `CvParam` Returns: `CvUnit option`	cvp : `CvParam` Returns: `CvUnit option`
`CvParam.tryGetCvUnitTermAccession cvp` Full Usage: `CvParam.tryGetCvUnitTermAccession cvp` Parameters: cvp : `CvParam` Returns: `string option`	cvp : `CvParam` Returns: `string option`
`CvParam.tryGetCvUnitTermName cvp` Full Usage: `CvParam.tryGetCvUnitTermName cvp` Parameters: cvp : `CvParam` Returns: `string option`	cvp : `CvParam` Returns: `string option`
`CvParam.tryGetCvUnitTermRef cvp` Full Usage: `CvParam.tryGetCvUnitTermRef cvp` Parameters: cvp : `CvParam` Returns: `string option`	cvp : `CvParam` Returns: `string option`
`CvParam.tryGetCvUnitValue cvp` Full Usage: `CvParam.tryGetCvUnitValue cvp` Parameters: cvp : `CvParam` Returns: `IConvertible option`	cvp : `CvParam` Returns: `IConvertible option`
`CvParam.tryGetValueAccession cvp` Full Usage: `CvParam.tryGetValueAccession cvp` Parameters: cvp : `CvParam` Returns: `string option`	cvp : `CvParam` Returns: `string option`
`CvParam.tryGetValueRef cvp` Full Usage: `CvParam.tryGetValueRef cvp` Parameters: cvp : `CvParam` Returns: `string option`	cvp : `CvParam` Returns: `string option`
`CvParam.tryMapValue f cvp` Full Usage: `CvParam.tryMapValue f cvp` Parameters: f : `ParamValue -> ParamValue option` cvp : `CvParam` Returns: `CvParam option`	f : `ParamValue -> ParamValue option` cvp : `CvParam` Returns: `CvParam option`