ColoredBeads

Bases: ManufacturerSpec_Type

Represents the XML element ColoredBeads.

This element describes a preparation of multi-Colored Fluorescent Beads (also referred to as Microspheres) used to facilitate the optical calibration of conventional fluorescence microscopes, confocal laser scanning microscopes, and associated image-processing equipments. These Beads are usually made of glass or plastic microspheres stained with one or more fluorescent dyes.

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
ColoredBeads	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.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LSID_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.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setDiameter(value, validate=True)

Sets the value of the Diameter attribute.

This field captures the Diameter of these Colored Beads.

Parameters:

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

getDiameter()

Returns the value of the Diameter attribute.

This field captures the Diameter of these Colored Beads.

Returns:

Type	Description
float	The value of the attribute

resetDiameter()

Resets the Diameter attribute to an unset state.

This field captures the Diameter of these Colored Beads.

hasDiameter()

Checks whether the Diameter attribute is present.

This field captures the Diameter of these Colored Beads.

Returns:

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

setDiameterUnit(value, validate=True)

Sets the value of the DiameterUnit attribute.

No description available in the XSD standard.

Parameters:

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

getDiameterUnit()

Returns the value of the DiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetDiameterUnit()

Resets the DiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setConcentration(value, validate=True)

Sets the value of the Concentration attribute.

This field captures the concentration of these Colored Beads.

Parameters:

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

getConcentration()

Returns the value of the Concentration attribute.

This field captures the concentration of these Colored Beads.

Returns:

Type	Description
float	The value of the attribute

resetConcentration()

Resets the Concentration attribute to an unset state.

This field captures the concentration of these Colored Beads.

hasConcentration()

Checks whether the Concentration attribute is present.

This field captures the concentration of these Colored Beads.

Returns:

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

setConcentrationUnit(value, validate=True)

Sets the value of the ConcentrationUnit attribute.

No description available in the XSD standard.

Parameters:

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

getConcentrationUnit()

Returns the value of the ConcentrationUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsConcentration_Type	The value of the attribute

resetConcentrationUnit()

Resets the ConcentrationUnit attribute to an unset state.

No description available in the XSD standard.

hasConcentrationUnit()

Checks whether the optional ConcentrationUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setType(value, validate=True)

Sets the value of the Type attribute.

This field captures the type of these Colored Beads.

Parameters:

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

getType()

Returns the value of the Type attribute.

This field captures the type of these Colored Beads.

Returns:

Type	Description
BeadType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field captures the type of these Colored Beads.

hasType()

Checks whether the optional Type attribute is present.

This field captures the type of these Colored Beads.

Returns:

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

setMaterial(value, validate=True)

Sets the value of the Material attribute.

This field capture the Material that is used to construct these Colored Beads.

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

getMaterial()

Returns the value of the Material attribute.

This field capture the Material that is used to construct these Colored Beads.

Returns:

Type	Description
string	The value of the attribute

resetMaterial()

Resets the Material attribute to an unset state.

This field capture the Material that is used to construct these Colored Beads.

hasMaterial()

Checks whether the Material attribute is present.

This field capture the Material that is used to construct these Colored Beads.

Returns:

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

getMaterialAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field capture the Material that is used to construct these Colored Beads.

Returns:

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

setWavelengthRange(value, validate=True)

Sets the value of the WavelengthRange element.

No description available in the XSD standard.

Parameters:

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

getWavelengthRange()

Returns the value of the WavelengthRange element.

No description available in the XSD standard.

Returns:

Type	Description
WavelengthRange	The value of the element

resetWavelengthRange()

Resets the WavelengthRange element to an unset state.

No description available in the XSD standard.

hasWavelengthRange()

Checks whether the optional WavelengthRange element is present.

No description available in the XSD standard.

Returns:

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