Inscoper::NBO::Screen¶

Represents the XML element Screen. More...

#include <Screen.h>

Inherits from NBOBaseClass

Public Classes¶

	Name
class	InlineDescription Represents the XML element Description.
class	InlinePlateRef Represents the XML element PlateRef.

Public Types¶

	Name
typedef std::shared_ptr< InlineDescription >	InlineDescriptionPtr
typedef std::shared_ptr< InlinePlateRef >	InlinePlateRefPtr

Public Functions¶

	Name
	Screen()
	~Screen()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::ScreenID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ScreenID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const std::string & value, bool validate =true) Sets the value of the Name attribute.
std::string	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the Name attribute is present.
void	setProtocolIdentifier(const std::string & value, bool validate =true) Sets the value of the ProtocolIdentifier attribute.
std::string	getProtocolIdentifier() const Returns the value of the ProtocolIdentifier attribute.
void	resetProtocolIdentifier() Resets the ProtocolIdentifier attribute to an unset state.
bool	hasProtocolIdentifier() const Checks whether the ProtocolIdentifier attribute is present.
void	setProtocolDescription(const std::string & value, bool validate =true) Sets the value of the ProtocolDescription attribute.
std::string	getProtocolDescription() const Returns the value of the ProtocolDescription attribute.
void	resetProtocolDescription() Resets the ProtocolDescription attribute to an unset state.
bool	hasProtocolDescription() const Checks whether the ProtocolDescription attribute is present.
void	setReagentSetDescription(const std::string & value, bool validate =true) Sets the value of the ReagentSetDescription attribute.
std::string	getReagentSetDescription() const Returns the value of the ReagentSetDescription attribute.
void	resetReagentSetDescription() Resets the ReagentSetDescription attribute to an unset state.
bool	hasReagentSetDescription() const Checks whether the ReagentSetDescription attribute is present.
void	setReagentSetIdentifier(const std::string & value, bool validate =true) Sets the value of the ReagentSetIdentifier attribute.
std::string	getReagentSetIdentifier() const Returns the value of the ReagentSetIdentifier attribute.
void	resetReagentSetIdentifier() Resets the ReagentSetIdentifier attribute to an unset state.
bool	hasReagentSetIdentifier() const Checks whether the ReagentSetIdentifier attribute is present.
void	setType(const std::string & value, bool validate =true) Sets the value of the Type attribute.
std::string	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the Type attribute is present.
void	setDescription(const Inscoper::NBO::Screen::InlineDescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::Screen::InlineDescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
void	setReagent_List(const std::vector< Inscoper::NBO::ReagentPtr > & value, bool validate =true) Sets the list of Reagent elements.
std::vector< Inscoper::NBO::ReagentPtr >	getReagent_List() const Returns the list of Reagent elements.
void	addToReagent_List(const Inscoper::NBO::ReagentPtr & value, bool validate =true) Adds a new Reagent element to this object.
void	clearReagent_List() Clear the list of Reagent.
void	setPlateRef_List(const std::vector< Inscoper::NBO::Screen::InlinePlateRefPtr > & value, bool validate =true) Sets the list of PlateRef elements.
std::vector< Inscoper::NBO::Screen::InlinePlateRefPtr >	getPlateRef_List() const Returns the list of PlateRef elements.
void	addToPlateRef_List(const Inscoper::NBO::Screen::InlinePlateRefPtr & value, bool validate =true) Adds a new PlateRef element to this object.
void	clearPlateRef_List() Clear the list of PlateRef.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< Screen >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Screen.
const std::set< std::string > &	getNameAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getProtocolIdentifierAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getProtocolDescriptionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getReagentSetDescriptionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getReagentSetIdentifierAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTypeAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Screen;

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.

Public Types Documentation¶

typedef InlineDescriptionPtr¶

typedef InlinePlateRefPtr¶

Public Functions Documentation¶

function Screen¶

function ~Screen¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setID¶

void setID(
    const Inscoper::NBO::ScreenID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const std::string & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getName¶

function resetName¶

function hasName¶

function setProtocolIdentifier¶

void setProtocolIdentifier(
    const std::string & value,
    bool validate =true
)

Sets the value of the ProtocolIdentifier attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function getProtocolIdentifier¶

std::string getProtocolIdentifier() const

Returns the value of the ProtocolIdentifier attribute.

Return: The value of the attribute

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

function resetProtocolIdentifier¶

function hasProtocolIdentifier¶

bool hasProtocolIdentifier() const

Checks whether the ProtocolIdentifier attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setProtocolDescription¶

void setProtocolDescription(
    const std::string & value,
    bool validate =true
)

Sets the value of the ProtocolDescription attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function getProtocolDescription¶

std::string getProtocolDescription() const

Returns the value of the ProtocolDescription attribute.

Return: The value of the attribute

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

function resetProtocolDescription¶

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

function hasProtocolDescription¶

bool hasProtocolDescription() const

Checks whether the ProtocolDescription attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setReagentSetDescription¶

void setReagentSetDescription(
    const std::string & value,
    bool validate =true
)

Sets the value of the ReagentSetDescription attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getReagentSetDescription¶

function resetReagentSetDescription¶

function hasReagentSetDescription¶

bool hasReagentSetDescription() const

Checks whether the ReagentSetDescription attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setReagentSetIdentifier¶

void setReagentSetIdentifier(
    const std::string & value,
    bool validate =true
)

Sets the value of the ReagentSetIdentifier attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getReagentSetIdentifier¶

function resetReagentSetIdentifier¶

function hasReagentSetIdentifier¶

bool hasReagentSetIdentifier() const

Checks whether the ReagentSetIdentifier attribute is present.

Return: true if the attribute has been set, false otherwise

No description available in the XSD standard.

function setType¶

void setType(
    const std::string & value,
    bool validate =true
)

Sets the value of the Type attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getType¶

function resetType¶

function hasType¶

function setDescription¶

void setDescription(
    const Inscoper::NBO::Screen::InlineDescriptionPtr & value,
    bool validate =true
)

Sets the value of the Description element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A description for the screen.

function getDescription¶

function resetDescription¶

function hasDescription¶

function setReagent_List¶

void setReagent_List(
    const std::vector< Inscoper::NBO::ReagentPtr > & value,
    bool validate =true
)

Sets the list of Reagent elements.

Parameters:

value The new list of Reagent elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getReagent_List¶

function addToReagent_List¶

void addToReagent_List(
    const Inscoper::NBO::ReagentPtr & value,
    bool validate =true
)

Adds a new Reagent element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearReagent_List¶

function setPlateRef_List¶

void setPlateRef_List(
    const std::vector< Inscoper::NBO::Screen::InlinePlateRefPtr > & value,
    bool validate =true
)

Sets the list of PlateRef elements.

Parameters:

value The new list of PlateRef elements
validate If true, validates constraints on value. Default is true.

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.

function getPlateRef_List¶

std::vector< Inscoper::NBO::Screen::InlinePlateRefPtr > getPlateRef_List() const

Returns the list of PlateRef elements.

Return: 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.

function addToPlateRef_List¶

void addToPlateRef_List(
    const Inscoper::NBO::Screen::InlinePlateRefPtr & value,
    bool validate =true
)

Adds a new PlateRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

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.

function clearPlateRef_List¶

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

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::AnnotationRefPtr > & value,
    bool validate =true
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAnnotationRef_List¶

std::vector< Inscoper::NBO::AnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearAnnotationRef_List¶

function fromBase¶

static std::shared_ptr< Screen > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Screen.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getNameAllowedValues¶

function getProtocolIdentifierAllowedValues¶

static const std::set< std::string > & getProtocolIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

function getProtocolDescriptionAllowedValues¶

static const std::set< std::string > & getProtocolDescriptionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

function getReagentSetDescriptionAllowedValues¶

static const std::set< std::string > & getReagentSetDescriptionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getReagentSetIdentifierAllowedValues¶

static const std::set< std::string > & getReagentSetIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

function getTypeAllowedValues¶

static const std::set< std::string > & getTypeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

Updated on 2026-09-23 at 16:50:39 +0200