Reagent

Bases: NBOBaseClass

Represents the XML element Reagent.

Reagent is used to describe a chemical or some other physical experimental parameter.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
Reagent	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value, validate=True)

Sets the value of the ID attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ReagentID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

No description available in the XSD standard.

Returns:

Type	Description
ReagentID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

hasID()

Checks whether the optional ID attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setName(value, validate=True)

Sets the value of the Name attribute.

A short name for the reagent.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getName()

Returns the value of the Name attribute.

A short name for the reagent.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A short name for the reagent.

hasName()

Checks whether the Name attribute is present.

A short name for the reagent.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getNameAllowedValues() staticmethod

Returns the allowed values for this attribut.

A short name for the reagent.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setReagentIdentifier(value, validate=True)

Sets the value of the ReagentIdentifier attribute.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getReagentIdentifier()

Returns the value of the ReagentIdentifier attribute.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

Returns:

Type	Description
string	The value of the attribute

resetReagentIdentifier()

Resets the ReagentIdentifier attribute to an unset state.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

hasReagentIdentifier()

Checks whether the ReagentIdentifier attribute is present.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getReagentIdentifierAllowedValues() staticmethod

Returns the allowed values for this attribut.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setDescription(value, validate=True)

Sets the value of the Description element.

A long description for the reagent.

Parameters:

Name	Type	Description	Default
value	Reagent_InlineDescription	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDescription()

Returns the value of the Description element.

A long description for the reagent.

Returns:

Type	Description
Reagent_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A long description for the reagent.

hasDescription()

Checks whether the optional Description element is present.

A long description for the reagent.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.