com.inscoper.nbo.TiffData

Represents the XML element TiffData. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	TiffData()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setIFD(NonNegativeInt_Type value, boolean validate) Sets the value of the IFD attribute.
void	setIFD(NonNegativeInt_Type value) Sets the value of the IFD attribute.
NonNegativeInt_Type	getIFD() Returns the value of the IFD attribute.
void	resetIFD() Resets the IFD attribute to an unset state.
boolean	hasIFD() Checks whether the optional IFD attribute is present.
void	setFirstZ(NonNegativeInt_Type value, boolean validate) Sets the value of the FirstZ attribute.
void	setFirstZ(NonNegativeInt_Type value) Sets the value of the FirstZ attribute.
NonNegativeInt_Type	getFirstZ() Returns the value of the FirstZ attribute.
void	resetFirstZ() Resets the FirstZ attribute to an unset state.
boolean	hasFirstZ() Checks whether the optional FirstZ attribute is present.
void	setFirstT(NonNegativeInt_Type value, boolean validate) Sets the value of the FirstT attribute.
void	setFirstT(NonNegativeInt_Type value) Sets the value of the FirstT attribute.
NonNegativeInt_Type	getFirstT() Returns the value of the FirstT attribute.
void	resetFirstT() Resets the FirstT attribute to an unset state.
boolean	hasFirstT() Checks whether the optional FirstT attribute is present.
void	setFirstC(NonNegativeInt_Type value, boolean validate) Sets the value of the FirstC attribute.
void	setFirstC(NonNegativeInt_Type value) Sets the value of the FirstC attribute.
NonNegativeInt_Type	getFirstC() Returns the value of the FirstC attribute.
void	resetFirstC() Resets the FirstC attribute to an unset state.
boolean	hasFirstC() Checks whether the optional FirstC attribute is present.
void	setPlaneCount(NonNegativeInt_Type value, boolean validate) Sets the value of the PlaneCount attribute.
void	setPlaneCount(NonNegativeInt_Type value) Sets the value of the PlaneCount attribute.
NonNegativeInt_Type	getPlaneCount() Returns the value of the PlaneCount attribute.
void	resetPlaneCount() Resets the PlaneCount attribute to an unset state.
boolean	hasPlaneCount() Checks whether the optional PlaneCount attribute is present.
void	setUUID(TiffData_InlineUUID value, boolean validate) Sets the value of the UUID element.
void	setUUID(TiffData_InlineUUID value) Sets the value of the UUID element.
TiffData_InlineUUID	getUUID() Returns the value of the UUID element.
void	resetUUID() Resets the UUID element to an unset state.
boolean	hasUUID() Checks whether the optional UUID element is present.
TiffData	__internal_create(long cPtr, boolean own)
TiffData	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions

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

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.TiffData;

Represents the XML element TiffData.

This field describes the location of the pixel data in a tiff file.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function TiffData

public TiffData()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path,
    boolean validate
)

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 fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string,
    boolean validate
)

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 fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path,
    boolean validate
)

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 fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string,
    boolean validate
)

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 fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename,
    boolean validate
)

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 toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

function toXmlString

public String toXmlString(
    boolean validate
)

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 toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setIFD

public void setIFD(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the IFD attribute.

Parameters:

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

Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]

function setIFD

public void setIFD(
    NonNegativeInt_Type value
)

Sets the value of the IFD attribute.

Parameters:

• value The value to set

Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]

function getIFD

public NonNegativeInt_Type getIFD()

Returns the value of the IFD attribute.

Return: The value of the attribute

Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]

function resetIFD

public void resetIFD()

Resets the IFD attribute to an unset state.

Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]

function hasIFD

public boolean hasIFD()

Checks whether the optional IFD attribute is present.

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

Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]

function setFirstZ

public void setFirstZ(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the FirstZ attribute.

Parameters:

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

Gives the Z position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]

function setFirstZ

public void setFirstZ(
    NonNegativeInt_Type value
)

Sets the value of the FirstZ attribute.

Parameters:

• value The value to set

Gives the Z position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]

function getFirstZ

public NonNegativeInt_Type getFirstZ()

Returns the value of the FirstZ attribute.

Return: The value of the attribute

Gives the Z position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]

function resetFirstZ

public void resetFirstZ()

Resets the FirstZ attribute to an unset state.

Gives the Z position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]

function hasFirstZ

public boolean hasFirstZ()

Checks whether the optional FirstZ attribute is present.

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

Gives the Z position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]

function setFirstT

public void setFirstT(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the FirstT attribute.

Parameters:

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

Gives the T position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]

function setFirstT

public void setFirstT(
    NonNegativeInt_Type value
)

Sets the value of the FirstT attribute.

Parameters:

• value The value to set

Gives the T position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]

function getFirstT

public NonNegativeInt_Type getFirstT()

Returns the value of the FirstT attribute.

Return: The value of the attribute

Gives the T position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]

function resetFirstT

public void resetFirstT()

Resets the FirstT attribute to an unset state.

Gives the T position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]

function hasFirstT

public boolean hasFirstT()

Checks whether the optional FirstT attribute is present.

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

Gives the T position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]

function setFirstC

public void setFirstC(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the FirstC attribute.

Parameters:

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

Gives the C position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]

function setFirstC

public void setFirstC(
    NonNegativeInt_Type value
)

Sets the value of the FirstC attribute.

Parameters:

• value The value to set

Gives the C position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]

function getFirstC

public NonNegativeInt_Type getFirstC()

Returns the value of the FirstC attribute.

Return: The value of the attribute

Gives the C position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]

function resetFirstC

public void resetFirstC()

Resets the FirstC attribute to an unset state.

Gives the C position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]

function hasFirstC

public boolean hasFirstC()

Checks whether the optional FirstC attribute is present.

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

Gives the C position of the ImagePlane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]

function setPlaneCount

public void setPlaneCount(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the PlaneCount attribute.

Parameters:

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

Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]

function setPlaneCount

public void setPlaneCount(
    NonNegativeInt_Type value
)

Sets the value of the PlaneCount attribute.

Parameters:

• value The value to set

Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]

function getPlaneCount

public NonNegativeInt_Type getPlaneCount()

Returns the value of the PlaneCount attribute.

Return: The value of the attribute

Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]

function resetPlaneCount

public void resetPlaneCount()

Resets the PlaneCount attribute to an unset state.

Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]

function hasPlaneCount

public boolean hasPlaneCount()

Checks whether the optional PlaneCount attribute is present.

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

Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]

function setUUID

public void setUUID(
    TiffData_InlineUUID value,
    boolean validate
)

Sets the value of the UUID element.

Parameters:

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

This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.

function setUUID

public void setUUID(
    TiffData_InlineUUID value
)

Sets the value of the UUID element.

Parameters:

• value The value to set

This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.

function getUUID

public TiffData_InlineUUID getUUID()

Returns the value of the UUID element.

Return: The value of the element

This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.

function resetUUID

public void resetUUID()

Resets the UUID element to an unset state.

This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.

function hasUUID

public boolean hasUUID()

Checks whether the optional UUID element is present.

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

This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.

function __internal_create

public static TiffData __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase

public static TiffData fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

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

Protected Functions Documentation

function TiffData

protected TiffData(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    TiffData obj
)

---

Updated on 2026-06-22 at 17:06:33 +0200