Inscoper::NBO::Pixels_Choice¶

Represents the XML choice in element Pixels.

#include <Pixels_Choice.h>

Inherits from NBOBaseClass

Public Types¶

	Name
using std::variant< std::vector< Inscoper::NBO::NGFFDataPtr >, std::vector< Inscoper::NBO::TiffDataPtr >, std::vector< Inscoper::NBO::MetadataOnlyPtr >, std::vector< Inscoper::NBO::BinDataPtr > >	Pixels_Choice_Variant
using std::shared_ptr< Pixels_Choice_Variant >	Pixels_Choice_VariantPtr

Public Functions¶

	Name
	Pixels_Choice()
	~Pixels_Choice()
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	addBinData(std::vector< Inscoper::NBO::BinDataPtr > value) Adds a new BinData element to this object.
bool	containsBinData() const Checks whether this object contains at least one BinData element.
void	addMetadataOnly(std::vector< Inscoper::NBO::MetadataOnlyPtr > value) Adds a new MetadataOnly element to this object.
bool	containsMetadataOnly() const Checks whether this object contains at least one MetadataOnly element.
void	addNGFFData(std::vector< Inscoper::NBO::NGFFDataPtr > value) Adds a new NGFFData element to this object.
bool	containsNGFFData() const Checks whether this object contains at least one NGFFData element.
void	addTiffData(std::vector< Inscoper::NBO::TiffDataPtr > value) Adds a new TiffData element to this object.
bool	containsTiffData() const Checks whether this object contains at least one TiffData element.
std::shared_ptr< Pixels_Choice >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Pixels_Choice.

Public Types Documentation¶

using Pixels_Choice_Variant¶

using Inscoper::NBO::Pixels_Choice::Pixels_Choice_Variant =  std::variant<
        std::vector<Inscoper::NBO::NGFFDataPtr>,
        std::vector<Inscoper::NBO::TiffDataPtr>,
        std::vector<Inscoper::NBO::MetadataOnlyPtr>,
        std::vector<Inscoper::NBO::BinDataPtr>
    >;

using Pixels_Choice_VariantPtr¶

Public Functions Documentation¶

function Pixels_Choice¶

function ~Pixels_Choice¶

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 addBinData¶

function containsBinData¶

function addMetadataOnly¶

function containsMetadataOnly¶

function addNGFFData¶

function containsNGFFData¶

function addTiffData¶

function containsTiffData¶

function fromBase¶

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

Cast a NBOBaseClass to a Pixels_Choice.

Parameters:

base The base class to cast

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

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