Header menu logo BioFSharp.Mz

ParamContainer Module

Module containing functions to operate on ParamContainer

Types

Type Description

ParamContainer

Type ParamContainer

Functions and values

Function or value Description

addOrUpdateInPlace param paramContainer

Full Usage: addOrUpdateInPlace param paramContainer

Parameters:
Returns: ParamContainer
param : CvParam
paramContainer : ParamContainer
Returns: ParamContainer

addOrUpdateInPlaceOf cvParams paramContainer

Full Usage: addOrUpdateInPlaceOf cvParams paramContainer

Parameters:
Returns: ParamContainer
cvParams : CvParam seq
paramContainer : ParamContainer
Returns: ParamContainer

getCvParam paramId paramContainer

Full Usage: getCvParam paramId paramContainer

Parameters:
Returns: CvParam

Get CvParam by id (Function can fail)

paramId : TermId
paramContainer : ParamContainer
Returns: CvParam

getValueAsFloat paramId paramContainer

Full Usage: getValueAsFloat paramId paramContainer

Parameters:
Returns: float

Get value as float by termid or 'nan'

paramId : TermId
paramContainer : ParamContainer
Returns: float

getValueAsInt paramId paramContainer

Full Usage: getValueAsInt paramId paramContainer

Parameters:
Returns: int

Get value as int32 by termid or '-1'

paramId : TermId
paramContainer : ParamContainer
Returns: int

getValueAsString paramId paramContainer

Full Usage: getValueAsString paramId paramContainer

Parameters:
Returns: string

Get value as string by termid or empty string

paramId : TermId
paramContainer : ParamContainer
Returns: string

ofSeq cvParams

Full Usage: ofSeq cvParams

Parameters:
Returns: Dictionary<TermId, CvParam>
cvParams : CvParam seq
Returns: Dictionary<TermId, CvParam>

tryGetCvParam paramId paramContainer

Full Usage: tryGetCvParam paramId paramContainer

Parameters:
Returns: CvParam option

Get optional CvParam by id

paramId : TermId
paramContainer : ParamContainer
Returns: CvParam option

Type something to start searching.