TiffDataType Class

Summary: The TIFF data type.

Module: aspose.imaging.fileformats.tiff

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

Properties

Name	Type	Access	Description
count	ulong	r	Gets the count of elements.
data_size	ulong	r	Gets the tag value size.
element_size	byte	r	Gets the element size in bytes.
id	ushort	r	Gets tag id as number.
is_valid	bool	r	Gets a value indicating whether tag data is valid. The valid tag contains data which may be preserved. The invalid tag cannot be stored.
tag_id	TiffTags	r	Gets the tag id.
tag_type	TiffDataTypes	r	Gets the tag type.
value	object	r/w	Gets or sets the value this data type contains.

Methods

Name	Description
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:

Parameter	Type	Description
obj	object	An object to compare with this instance.

Returns

Type	Description
int	A 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

Type	Description
TiffDataType	A 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:

Parameter	Type	Description
size_of_tag_value	byte	Size of tag value: 4 or 8 for BigTiff.

Returns

Type	Description
ulong	The 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:

Parameter	Type	Description
size_of_tag_value	byte	Size of tag value.

Returns

Type	Description
ulong	The aligned data size in bytes.

Method: read_tag(data_stream, position) [static]

 read_tag(data_stream, position) 

Reads the tag data.

Parameters:

Parameter	Type	Description
data_stream	TiffStreamReader	The data stream.
position	long	The tag position.

Returns

Type	Description
TiffDataType	The read tag.

Method: write_additional_data(data_stream)

 write_additional_data(data_stream) 

Writes the additional tag data.

Parameters:

Parameter	Type	Description
data_stream	TiffStreamWriter	The data stream.

Returns

Type	Description
long	The actual bytes written.

Method: write_tag(data_stream, additional_data_offset)

 write_tag(data_stream, additional_data_offset) 

Writes the tag data.

Parameters:

Parameter	Type	Description
data_stream	TiffStreamWriter	The data stream.
additional_data_offset	long	The offset to write additional data to.