com.inscoper.api.Dimension¶

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

Public Functions¶

	Name
synchronized void	delete()
	Dimension() Default constructor.
	Dimension(String name) Constructor with name.
	Dimension(String name, SubDeviceIdVector subDeviceIdList) Constructor with name and device list.
void	fromXML(XMLNode xml) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
void	addSubDevice(SubDeviceId subDeviceId) Add a sub-device to the dimension.
void	addDimensionParam(DimensionParam param) Add parameters to the dimension.
String	getName() Get the name of the dimension.
DimensionParamVector	getDimensionParams() Get parameters of the dimension.
SubDeviceIdVector	subDeviceIdList() Get the sub-device ID list of the dimension.

Protected Functions¶

	Name
	Dimension(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Dimension obj)

Detailed Description¶

public class com.inscoper.api.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 delete¶

public synchronized void delete()

function Dimension¶

public Dimension()

Default constructor.

Initializes a new instance of the Dimension class.

function Dimension¶

public Dimension(
    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¶

public Dimension(
    String name,
    SubDeviceIdVector 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 fromXML¶

public void fromXML(
    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¶

public void toXML(
    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¶

public void addSubDevice(
    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¶

public void addDimensionParam(
    DimensionParam param
)

Add parameters to the dimension.

Parameters:

param : The parameters to add to the dimension

Adds parameters to this dimension.

function getName¶

public String getName()

Get the name of the dimension.

Return: The name of the dimension

Retrieves the name of the dimension.

function getDimensionParams¶

public DimensionParamVector getDimensionParams()

Get parameters of the dimension.

Return: The list of parameters of the dimension

Retrieves the list of parameters defined for this dimension.

function subDeviceIdList¶

public SubDeviceIdVector subDeviceIdList()

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.

Protected Functions Documentation¶

function Dimension¶

protected Dimension(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Dimension obj
)

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