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
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 )
setName ( value , validate = True )
getNameAllowedValues ()
staticmethod
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
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 )
resetProtocolDescription ()
getProtocolDescriptionAllowedValues ()
staticmethod
setReagentSetDescription ( value , validate = True )
getReagentSetDescription ()
resetReagentSetDescription ()
hasReagentSetDescription ()
getReagentSetDescriptionAllowedValues ()
staticmethod
setReagentSetIdentifier ( value , validate = True )
getReagentSetIdentifier ()
resetReagentSetIdentifier ()
hasReagentSetIdentifier ()
getReagentSetIdentifierAllowedValues ()
staticmethod
setType ( value , validate = True )
getTypeAllowedValues ()
staticmethod
setDescription ( value , validate = True )
setReagent_List ( value , validate = True )
addToReagent_List ( value , validate = True )
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
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 )
addToAnnotationRef_List ( value , validate = True )
clearAnnotationRef_List ()