TiffDataType Class

Summary: The TIFF data type.

Module: aspose.imaging.fileformats.tiff

Full Name: aspose.imaging.fileformats.tiff.TiffDataType

Properties

NameTypeAccessDescription
countintrGets the count of elements.
data_sizeintrGets the tag value size.
element_sizeSystem.ByterGets the element size in bytes.
idintrGets tag id as number.
is_validboolrGets a value indicating whether tag data is valid. The valid tag contains data which may be preserved. The invalid tag cannot be stored.
tag_idTiffTagsrGets the tag id.
tag_typeTiffDataTypesrGets the tag type.
valueSystem.Objectr/wGets or sets the value this data type contains.

Methods

NameDescription
compare_to(obj)Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
deep_clone()Performs a deep clone of this instance.
get_additional_data_size(size_of_tag_value)Gets the additional tag value size in bytes (in case the tag can not fit the whole tag value).
get_aligned_data_size(size_of_tag_value)Gets the data size aligned in 4-byte (int) or 8-byte (long) boundary.
read_tag(data_stream, position)Reads the tag data.
write_additional_data(data_stream)Writes the additional tag data.
write_tag(data_stream, additional_data_offset)Writes the tag data.

Method: compare_to(obj)

 compare_to(obj) 

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters:

ParameterTypeDescription
objSystem.ObjectAn object to compare with this instance.

Returns

TypeDescription
intA 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
Value
Meaning
Less than zero
This instance is less than obj.
Zero
This instance is equal to obj.
Greater than zero
This instance is greater than obj.

Method: deep_clone()

 deep_clone() 

Performs a deep clone of this instance.

Returns

TypeDescription
TiffDataTypeA deep clone of the current instance.

Method: get_additional_data_size(size_of_tag_value)

 get_additional_data_size(size_of_tag_value) 

Gets the additional tag value size in bytes (in case the tag can not fit the whole tag value).

Parameters:

ParameterTypeDescription
size_of_tag_valueSystem.ByteSize of tag value: 4 or 8 for BigTiff.

Returns

TypeDescription
intThe additional data size in bytes.

Method: get_aligned_data_size(size_of_tag_value)

 get_aligned_data_size(size_of_tag_value) 

Gets the data size aligned in 4-byte (int) or 8-byte (long) boundary.

Parameters:

ParameterTypeDescription
size_of_tag_valueSystem.ByteSize of tag value.

Returns

TypeDescription
intThe aligned data size in bytes.

Method: read_tag(data_stream, position) [static]

 read_tag(data_stream, position) 

Reads the tag data.

Parameters:

ParameterTypeDescription
data_streamTiffStreamReaderThe data stream.
positionintThe tag position.

Returns

TypeDescription
TiffDataTypeThe read tag.

Method: write_additional_data(data_stream)

 write_additional_data(data_stream) 

Writes the additional tag data.

Parameters:

ParameterTypeDescription
data_streamTiffStreamWriterThe data stream.

Returns

TypeDescription
intThe actual bytes written.

Method: write_tag(data_stream, additional_data_offset)

 write_tag(data_stream, additional_data_offset) 

Writes the tag data.

Parameters:

ParameterTypeDescription
data_streamTiffStreamWriterThe data stream.
additional_data_offsetintThe offset to write additional data to.