Screen

Bases: NBOBaseClass

Represents the XML element Screen.

The Screen element is a grouping for Plates. The required attribute is the Screen's Name and ID - both must be unique within the document. The Screen element may contain an ExternalRef attribute that refers to an external database. A description of the screen may be specified in the Description element. Screens may contain overlapping sets of Plates i.e. Screens and Plates have a many-to-many relationship. Plates contain one or more ScreenRef elements to specify what screens they belong to.

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
Screen	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	ScreenID_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
ScreenID_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.

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

getName()

Returns the value of the Name attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

No description available in the XSD standard.

hasName()

Checks whether the Name attribute is present.

No description available in the XSD standard.

Returns:

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

getNameAllowedValues() 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

setProtocolIdentifier(value, validate=True)

Sets the value of the ProtocolIdentifier attribute.

A pointer to an externally defined protocol, usually in a screening database.

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

getProtocolIdentifier()

Returns the value of the ProtocolIdentifier attribute.

A pointer to an externally defined protocol, usually in a screening database.

Returns:

Type	Description
string	The value of the attribute

resetProtocolIdentifier()

Resets the ProtocolIdentifier attribute to an unset state.

A pointer to an externally defined protocol, usually in a screening database.

hasProtocolIdentifier()

Checks whether the ProtocolIdentifier attribute is present.

A pointer to an externally defined protocol, usually in a screening database.

Returns:

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

getProtocolIdentifierAllowedValues() staticmethod

Returns the allowed values for this attribut.

A pointer to an externally defined protocol, usually in a screening database.

Returns:

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

setProtocolDescription(value, validate=True)

Sets the value of the ProtocolDescription attribute.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

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

getProtocolDescription()

Returns the value of the ProtocolDescription attribute.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

Returns:

Type	Description
string	The value of the attribute

resetProtocolDescription()

Resets the ProtocolDescription attribute to an unset state.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

hasProtocolDescription()

Checks whether the ProtocolDescription attribute is present.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

Returns:

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

getProtocolDescriptionAllowedValues() staticmethod

Returns the allowed values for this attribut.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

Returns:

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

setReagentSetDescription(value, validate=True)

Sets the value of the ReagentSetDescription 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

getReagentSetDescription()

Returns the value of the ReagentSetDescription attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetReagentSetDescription()

Resets the ReagentSetDescription attribute to an unset state.

No description available in the XSD standard.

hasReagentSetDescription()

Checks whether the ReagentSetDescription attribute is present.

No description available in the XSD standard.

Returns:

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

getReagentSetDescriptionAllowedValues() 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

setReagentSetIdentifier(value, validate=True)

Sets the value of the ReagentSetIdentifier 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

getReagentSetIdentifier()

Returns the value of the ReagentSetIdentifier attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetReagentSetIdentifier()

Resets the ReagentSetIdentifier attribute to an unset state.

No description available in the XSD standard.

hasReagentSetIdentifier()

Checks whether the ReagentSetIdentifier attribute is present.

No description available in the XSD standard.

Returns:

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

getReagentSetIdentifierAllowedValues() 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

setType(value, validate=True)

Sets the value of the Type 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

getType()

Returns the value of the Type attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

No description available in the XSD standard.

hasType()

Checks whether the Type attribute is present.

No description available in the XSD standard.

Returns:

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

getTypeAllowedValues() 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

setDescription(value, validate=True)

Sets the value of the Description element.

A description for the screen.

Parameters:

Name	Type	Description	Default
value	Screen_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 description for the screen.

Returns:

Type	Description
Screen_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A description for the screen.

hasDescription()

Checks whether the optional Description element is present.

A description for the screen.

Returns:

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

setReagent_List(value, validate=True)

Sets the list of Reagent elements.

No description available in the XSD standard.

Parameters:

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

getReagent_List()

Returns the list of Reagent elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Reagen]	The list of Reagent elements

addToReagent_List(value, validate=True)

Adds a new Reagent element to this object.

No description available in the XSD standard.

Parameters:

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

clearReagent_List()

Clear the list of Reagent.

No description available in the XSD standard.

setPlateRef_List(value, validate=True)

Sets the list of PlateRef elements.

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

Parameters:

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

getPlateRef_List()

Returns the list of PlateRef elements.

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

Returns:

Type	Description
List[Screen_InlinePlateRef]	The list of PlateRef elements

addToPlateRef_List(value, validate=True)

Adds a new PlateRef element to this object.

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

Parameters:

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

clearPlateRef_List()

Clear the list of PlateRef.

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

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.