Header menu logo ARCTokenization

CvAttributeCollection Type

Contains attributes by which to qualify a cv object

Constructors

Constructor Description

CvAttributeCollection(attributes)

Full Usage: CvAttributeCollection(attributes)

Parameters:
Returns: CvAttributeCollection
attributes : IParam seq
Returns: CvAttributeCollection

CvAttributeCollection(attributes)

Full Usage: CvAttributeCollection(attributes)

Parameters:
Returns: CvAttributeCollection
attributes : IDictionary<string, IParam>
Returns: CvAttributeCollection

Instance members

Instance member Description

this.AddAttribute

Full Usage: this.AddAttribute

Parameters:

Add an IParam as an attribute. Fails, if an attribute with the same key already exists

param : IParam

this.Attributes

Full Usage: this.Attributes

Returns: IParam list

Returns all attributes as a list

Returns: IParam list

this.ContainsAttribute

Full Usage: this.ContainsAttribute

Parameters:
Returns: bool

Returns true, if an attribute with the given term exists in the collection

term : CvTerm
Returns: bool

this.ContainsAttribute

Full Usage: this.ContainsAttribute

Parameters:
    name : string

Returns: bool

Returns true, if an attribute with the given name exists in the collection

name : string
Returns: bool

this.GetAttribute

Full Usage: this.GetAttribute

Parameters:
Returns: IParam

Retrieves an IParam attribute by its term, if it exists, else fails

term : CvTerm
Returns: IParam

this.GetAttribute

Full Usage: this.GetAttribute

Parameters:
    name : string

Returns: IParam

Retrieves an IParam attribute by its name, if it exists, else fails

name : string
Returns: IParam

this.IsStructuralChildOf

Full Usage: this.IsStructuralChildOf

Parameters:
Returns: bool

Returns true, if an attribute with the same term as the given parent exists in the collection

parent : ICvBase
Returns: bool

this.TryAddAttribute

Full Usage: this.TryAddAttribute

Parameters:
Returns: bool

Add an IParam as an attribute. Does not fail, if an attribute with the same key already exists

param : IParam
Returns: bool

this.TryGetAttribute

Full Usage: this.TryGetAttribute

Parameters:
Returns: IParam option

Retrieves an IParam attribute by its term, if it exists, else returns None

term : CvTerm
Returns: IParam option

this.TryGetAttribute

Full Usage: this.TryGetAttribute

Parameters:
    name : string

Returns: IParam option

Retrieves an IParam attribute by its name, if it exists, else returns None

name : string
Returns: IParam option

Static members

Static member Description

CvAttributeCollection.containsAttribute name v

Full Usage: CvAttributeCollection.containsAttribute name v

Parameters:
Returns: bool

Returns true, if it implements a CvAttributeCollection and the attribute exists

name : string
v : IAttributeCollection
Returns: bool

CvAttributeCollection.containsAttributeTerm term v

Full Usage: CvAttributeCollection.containsAttributeTerm term v

Parameters:
Returns: bool

Returns true, if it implements a CvAttributeCollection and the attribute exists

term : CvTerm
v : IAttributeCollection
Returns: bool

CvAttributeCollection.isStructuralChildOf parent child

Full Usage: CvAttributeCollection.isStructuralChildOf parent child

Parameters:
Returns: bool

Returns true, if an attribute with the same term as the given parent exists in the collection

parent : ICvBase
child : IAttributeCollection
Returns: bool

CvAttributeCollection.tryAddAttribute param v

Full Usage: CvAttributeCollection.tryAddAttribute param v

Parameters:
Returns: bool

Returns the attribute of the value, if it implements CvAttributeCollection and the attribute exists, else returns None

param : IParam
v : IAttributeCollection
Returns: bool

CvAttributeCollection.tryGetAttribute name v

Full Usage: CvAttributeCollection.tryGetAttribute name v

Parameters:
Returns: IParam option

Returns the attribute of the value, if it implements CvAttributeCollection and the attribute exists, else returns None

name : string
v : IAttributeCollection
Returns: IParam option

CvAttributeCollection.tryGetAttributeByTerm term v

Full Usage: CvAttributeCollection.tryGetAttributeByTerm term v

Parameters:
Returns: IParam option

Returns the attribute of the value, if it implements CvAttributeCollection and the attribute exists, else returns None

term : string
v : IAttributeCollection
Returns: IParam option

Type something to start searching.