Experimenter¶

Bases: NBOBaseClass

Represents the XML element Experimenter.

This element describes a person who performed an imaging experiment. This person may also be a user of the OME system, in which case the UserName element contains their login name.Experimenters may belong to one or more groups which are specified using one or more ExperimenterGroupRef elements.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Experimenter.

Parameters:

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

Returns:

Type	Description
`Experimenter`	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`	`ExperimenterID_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
`ExperimenterID_Type`	The value of the attribute

`resetID()` ¶

`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

`setFirstName(value, validate=True)` ¶

Sets the value of the FirstName attribute.

No description available in the XSD standard.

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`

`getFirstName()` ¶

Returns the value of the FirstName attribute.

No description available in the XSD standard.

Returns:

Type	Description
`string`	The value of the attribute

`resetFirstName()` ¶

`hasFirstName()` ¶

Checks whether the FirstName attribute is present.

No description available in the XSD standard.

Returns:

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

`getFirstNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

`setMiddleName(value, validate=True)` ¶

Sets the value of the MiddleName attribute.

No description available in the XSD standard.

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`

`getMiddleName()` ¶

Returns the value of the MiddleName attribute.

No description available in the XSD standard.

Returns:

Type	Description
`string`	The value of the attribute

`resetMiddleName()` ¶

`hasMiddleName()` ¶

Checks whether the MiddleName attribute is present.

No description available in the XSD standard.

Returns:

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

`getMiddleNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

`setLastName(value, validate=True)` ¶

Sets the value of the LastName attribute.

No description available in the XSD standard.

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`

`getLastName()` ¶

Returns the value of the LastName attribute.

No description available in the XSD standard.

Returns:

Type	Description
`string`	The value of the attribute

`resetLastName()` ¶

`hasLastName()` ¶

Checks whether the LastName attribute is present.

No description available in the XSD standard.

Returns:

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

`getLastNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

`setEmail(value, validate=True)` ¶

Sets the value of the Email attribute.

No description available in the XSD standard.

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`

`getEmail()` ¶

Returns the value of the Email attribute.

No description available in the XSD standard.

Returns:

Type	Description
`string`	The value of the attribute

`resetEmail()` ¶

`hasEmail()` ¶

Checks whether the Email attribute is present.

No description available in the XSD standard.

Returns:

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

`getEmailAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

`setInstitution(value, validate=True)` ¶

Sets the value of the Institution attribute.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

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`

`getInstitution()` ¶

Returns the value of the Institution attribute.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

Returns:

Type	Description
`string`	The value of the attribute

`resetInstitution()` ¶

`hasInstitution()` ¶

Checks whether the Institution attribute is present.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

Returns:

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

`getInstitutionAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

A person's Institution The organizing structure that people belong to other than groups. A university, or company, etc. We do not specify a department element, and do not mean for Institution to be used in this way. We simply wish to say XXX at YYY. Where YYY has a better chance of being tied to a geographically fixed location and of being more recognizable than a group of experimenters. [plain text string]

Returns:

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

`setUserName(value, validate=True)` ¶

Sets the value of the UserName attribute.

No description available in the XSD standard.

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`

`getUserName()` ¶

Returns the value of the UserName attribute.

No description available in the XSD standard.

Returns:

Type	Description
`string`	The value of the attribute

`resetUserName()` ¶

`hasUserName()` ¶

Checks whether the UserName attribute is present.

No description available in the XSD standard.

Returns:

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

`getUserNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

`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`

Experimenter¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setID(value, validate=True) ¶

getID() ¶

resetID() ¶

hasID() ¶

setFirstName(value, validate=True) ¶

getFirstName() ¶

resetFirstName() ¶

hasFirstName() ¶

getFirstNameAllowedValues() staticmethod ¶

setMiddleName(value, validate=True) ¶

getMiddleName() ¶

resetMiddleName() ¶

hasMiddleName() ¶

getMiddleNameAllowedValues() staticmethod ¶

setLastName(value, validate=True) ¶

getLastName() ¶

resetLastName() ¶

hasLastName() ¶

getLastNameAllowedValues() staticmethod ¶

setEmail(value, validate=True) ¶

getEmail() ¶

resetEmail() ¶

hasEmail() ¶

getEmailAllowedValues() staticmethod ¶

setInstitution(value, validate=True) ¶

getInstitution() ¶

resetInstitution() ¶

hasInstitution() ¶

getInstitutionAllowedValues() staticmethod ¶

setUserName(value, validate=True) ¶

getUserName() ¶

resetUserName() ¶

hasUserName() ¶

getUserNameAllowedValues() staticmethod ¶

setAnnotationRef_List(value, validate=True) ¶

getAnnotationRef_List() ¶

addToAnnotationRef_List(value, validate=True) ¶

clearAnnotationRef_List() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setID(value, validate=True)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setFirstName(value, validate=True)` ¶

`getFirstName()` ¶

`resetFirstName()` ¶

`hasFirstName()` ¶

`getFirstNameAllowedValues()` `staticmethod` ¶

`setMiddleName(value, validate=True)` ¶

`getMiddleName()` ¶

`resetMiddleName()` ¶

`hasMiddleName()` ¶

`getMiddleNameAllowedValues()` `staticmethod` ¶

`setLastName(value, validate=True)` ¶

`getLastName()` ¶

`resetLastName()` ¶

`hasLastName()` ¶

`getLastNameAllowedValues()` `staticmethod` ¶

`setEmail(value, validate=True)` ¶

`getEmail()` ¶

`resetEmail()` ¶

`hasEmail()` ¶

`getEmailAllowedValues()` `staticmethod` ¶

`setInstitution(value, validate=True)` ¶

`getInstitution()` ¶

`resetInstitution()` ¶

`hasInstitution()` ¶

`getInstitutionAllowedValues()` `staticmethod` ¶

`setUserName(value, validate=True)` ¶

`getUserName()` ¶

`resetUserName()` ¶

`hasUserName()` ¶

`getUserNameAllowedValues()` `staticmethod` ¶

`setAnnotationRef_List(value, validate=True)` ¶

`getAnnotationRef_List()` ¶

`addToAnnotationRef_List(value, validate=True)` ¶

`clearAnnotationRef_List()` ¶