Skip to content

TiffData_InlineUUID

Bases: UniversallyUniqueIdentifier_Type

Represents the XML element UUID.

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

getTypeName()

Returns the class type name.

Returns:

Type Description
string

The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type Description
string

The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type Description
int

The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type Description
List[NBOBaseClass]

The list of derived classes

getSubElements()

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

Returns:

Type Description
List[NBOBaseClass]

The list of child classes

fromJsonFile(path)

Populates this object from a JSON file.

Parameters:

Name Type Description Default
path string

The path to the JSON file

required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name Type Description Default
json_string string

The JSON content as a string

required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name Type Description Default
path string

The path to the XML file

required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name Type Description Default
xml_string string

The XML content as a string

required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name Type Description Default
filename string

The path to the output XML file

required

toXmlString()

Serializes this object to an XML string.

Returns:

Type Description
string

A string containing the XML representation of this object

setFileName(value)

Sets the value of the FileName attribute.

This can be used when the IFDs are located in another file. The / (forward slash) is used as the path separator. A relative path is recommended. However an absolute path can be specified. Default is to use the file the ome-xml data has been pulled from. Note: It is permissible for this to be self referential. The file image1.tiff may contain ome-xml data that has FilePath="image1.tiff" or "./image1.tiff"

Parameters:

Name Type Description Default
value string

The value to set

required

getFileName()

Returns the value of the FileName attribute.

This can be used when the IFDs are located in another file. The / (forward slash) is used as the path separator. A relative path is recommended. However an absolute path can be specified. Default is to use the file the ome-xml data has been pulled from. Note: It is permissible for this to be self referential. The file image1.tiff may contain ome-xml data that has FilePath="image1.tiff" or "./image1.tiff"

Returns:

Type Description
string

The value of the attribute

resetFileName()

Resets the FileName attribute to an unset state.

This can be used when the IFDs are located in another file. The / (forward slash) is used as the path separator. A relative path is recommended. However an absolute path can be specified. Default is to use the file the ome-xml data has been pulled from. Note: It is permissible for this to be self referential. The file image1.tiff may contain ome-xml data that has FilePath="image1.tiff" or "./image1.tiff"

hasFileName()

Checks whether the optional FileName attribute is present.

This can be used when the IFDs are located in another file. The / (forward slash) is used as the path separator. A relative path is recommended. However an absolute path can be specified. Default is to use the file the ome-xml data has been pulled from. Note: It is permissible for this to be self referential. The file image1.tiff may contain ome-xml data that has FilePath="image1.tiff" or "./image1.tiff"

Returns:

Type Description
boolean

true if the optional attribute has been set, false otherwise