Inscoper::Dimension¶

Dimension class manages the parameters of a dimension (within a multi-dimensional acquisition). More...

#include <Dimension.h>

Public Functions¶

	Name
	Dimension() Default constructor.
	Dimension(const std::string & name) Constructor with name.
	Dimension(const std::string & name, const std::vector< Inscoper::SubDeviceId > & subDeviceIdList) Constructor with name and device list.
	~Dimension() Default destructor.
void	fromXML(Inscoper::XMLNode & xml) Load from XML.
void	toXML(Inscoper::XMLNode & xmlParent) Save to XML.
void	addSubDevice(const Inscoper::SubDeviceId & subDeviceId) Add a sub-device to the dimension.
void	addDimensionParam(const Inscoper::DimensionParamPtr & param) Add parameters to the dimension.
const std::string &	getName() const Get the name of the dimension.
const std::vector< Inscoper::DimensionParamPtr > &	getDimensionParams() const Get parameters of the dimension.
const std::vector< Inscoper::SubDeviceId > &	subDeviceIdList() const Get the sub-device ID list of the dimension.

Detailed Description¶

class Inscoper::Dimension;

Dimension class manages the parameters of a dimension (within a multi-dimensional acquisition).

This class defines a dimension for a multi-dimensional acquisition sequence, managing the list of sub-devices involved and their parameters.

Public Functions Documentation¶

function Dimension¶

Dimension()

Default constructor.

Initializes a new instance of the Dimension class.

function Dimension¶

explicit Dimension(
    const std::string & name
)

Constructor with name.

Parameters:

name : The name of the dimension

Initializes a new instance of the Dimension class with a specific name.

function Dimension¶

Dimension(
    const std::string & name,
    const std::vector< Inscoper::SubDeviceId > & subDeviceIdList
)

Constructor with name and device list.

Parameters:

name : The name of the dimension
subDeviceIdList : The list of associated sub-devices

Initializes a new instance of the Dimension class with a name and a list of associated sub-devices.

function ~Dimension¶

~Dimension()

Default destructor.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & xml
)

Load from XML.

Parameters:

xml : The XML node containing dimension information

Exceptions:

InscoperException If an error occurs

Populates the dimension information from an XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Exports the dimension information to an XML node attached to the parent XML node.

function addSubDevice¶

void addSubDevice(
    const Inscoper::SubDeviceId & subDeviceId
)

Add a sub-device to the dimension.

Parameters:

subDeviceId : The sub-device ID of the sub-device to add to the dimension

Associates a sub-device with this dimension.

function addDimensionParam¶

void addDimensionParam(
    const Inscoper::DimensionParamPtr & param
)

Add parameters to the dimension.

Parameters:

param : The parameters to add to the dimension

Adds parameters to this dimension.

function getName¶

const std::string & getName() const

Get the name of the dimension.

Return: The name of the dimension

Retrieves the name of the dimension.

function getDimensionParams¶

const std::vector< Inscoper::DimensionParamPtr > & getDimensionParams() const

Get parameters of the dimension.

Return: The list of parameters of the dimension

Retrieves the list of parameters defined for this dimension.

function subDeviceIdList¶

const std::vector< Inscoper::SubDeviceId > & subDeviceIdList() const

Get the sub-device ID list of the dimension.

Return: The list of sub-device IDs of the dimension

Retrieves the list of sub-device IDs associated with this dimension.

Updated on 2026-04-02 at 10:55:35 +0200