Inscoper::NBO::ImagingMethodList_Type¶

Represents the XML simple type ImagingMethodList. More...

#include <ImagingMethodList_Type.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	ImagingMethodList_Type()
	~ImagingMethodList_Type()
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.
ImagingMethodList_Type &	operator=(const std::string & v) Assigns a new value to this object (= operator operator).
	operator std::string() const Returns the value of this object (generic conversion operator overload).
void	set(const std::string & v, bool validate =true) Assigns a new value to this object.
std::string	get() const Returns the value of this object.
std::shared_ptr< ImagingMethodList_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a ImagingMethodList_Type.
const std::set< std::string > &	getAllowedValues() Returns the allowed values for this object.
const std::string &	getPattern() Returns the pattern for this object.

Friends¶

	Name
std::ostream &	operator<<(std::ostream & os, const ImagingMethodList_Type & u)

Detailed Description¶

class Inscoper::NBO::ImagingMethodList_Type;

Represents the XML simple type ImagingMethodList.

No description available in the XSD standard.

Allowed values: 4DPlus, Coherent Anti-Stokes Raman Scattering (CARS), Confocal_Fluorescence_array-raster-scan, Confocal_Fluorescence_single-spot-raster-scan, Confocal_Fluorescence_slit-raster-scan, Confocal_Fluorescence_spinning disk, Confocal_Fluorescence_swept-field, Confocal_Fluorescence_Two-photon laser scanning microscopy, Confocal_Fluorescence_Multi-photon laser scanning microscopy, Fluorescence Correlation Spectroscopy (FCS), Light Sheet Fluorescence Microscopy (LSFM), Near Field Scanning Optical Microscopy (NSOM), Optical coherence tomography (OCT), Second-Harmonic Imaging Microscopy (SHIM), Spectral Imaging, SPIM (Selective or Single [Plane](/LiMi/1.4/nbo/cpp/Classes/class_inscoper_1_1_n_b_o_1_1_plane/) Illumination Microscopy), Super-Resolution_GSD (Ground State Depletion Scanning), Super-Resolution_DOPI (Defocussed Oorientation and Position Imaging), Super-Resolution_FIONA (Fluorescence Imaging With One Nanometer Accuracy), Super-Resolution_PAINT ([Point](/LiMi/1.4/nbo/cpp/Classes/class_inscoper_1_1_n_b_o_1_1_point/) Accumulation for Imaging In Nanoscale Topography), Super-Resolution_PALM (Photoactivation Localization Microscopy), Super-Resolution_STORM (Stochastic Optical Reconstruction Microscopy), Super-Resolution_STED (Stimulated Emission Depletion), Super-Resolution_SIM (Structured Illumination Microscopy), TIRF (Total Total Internal Reflection Fluorescence), Transmitted_Bright-field, Transmitted_Dark-field, Transmitted_Dark-field_Evanescent wave scattering, Transmitted_Differential Intensity Contrast (DIC; Nomarski), Transmitted_Hoffman modulation, Transmitted_Phase contrast (Zernicke), Transmitted_Polarization, Transmitted_Oblique illumination, Transmitted_Varel contrast, Wide-field_Fluorescence, Widefield_Fluorescence_FLIM (Fluorescence Lifetime Imaging), Widefield_Fluorescence_FLIP (Fluorescence Loss in Photobleaching), Widefield_Fluorescence_FRAP (Fluorescence Recovery After Photobleaching), Widefield_Fluorescence_FRET (Förster Resonance Energy Transfer), Widefield_Fluorescence_SPIM (Selective or Single [Plane](/LiMi/1.4/nbo/cpp/Classes/class_inscoper_1_1_n_b_o_1_1_plane/) Illumination Microscopy), Widefield_Fluorescence_TIRF (Total Internal Reflection Fluorescence), Other

Public Functions Documentation¶

function ImagingMethodList_Type¶

function ~ImagingMethodList_Type¶

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 operator=¶

function operator std::string¶

function set¶

void set(
    const std::string & v,
    bool validate =true
)

Assigns a new value to this object.

Parameters:

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

function get¶

function fromBase¶

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

Cast a NBOBaseClass to a ImagingMethodList_Type.

Parameters:

base The base class to cast

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

Inscoper::NBO::ImagingMethodList_Type¶

Public Functions¶

Friends¶

Detailed Description¶

Public Functions Documentation¶

function ImagingMethodList_Type¶

function ~ImagingMethodList_Type¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlString¶

function toXmlFile¶

function toXmlString¶

function operator=¶

function operator std::string¶

function set¶

function get¶

function fromBase¶

function getAllowedValues¶

function getPattern¶

Friends¶

friend operator<<¶