TiffStreamReader Class

Summary: The tiff stream for handling little endian tiff file format.

Module: aspose.imaging.fileformats.tiff.filemanagement

Full Name: aspose.imaging.fileformats.tiff.filemanagement.TiffStreamReader

Constructors

NameDescription
TiffStreamReader(data)Initializes a new instance of the TiffStreamReader class.
TiffStreamReader(data, start_index)Initializes a new instance of the TiffStreamReader class.
TiffStreamReader(data, start_index, data_length)Initializes a new instance of the TiffStreamReader class.
TiffStreamReader(stream_container)Initializes a new instance of the TiffStreamReader class.

Properties

NameTypeAccessDescription
lengthlongrGets the reader length.
throw_exceptionsboolr/wGets or sets a value indicating whether exceptions are thrown on incorrect data processing (reading or writing to stream).

Methods

NameDescription
read_bytes(array, array_index, position, count)Reads an array of byte values from the stream.
read_bytes(position, count)Reads an array of unsigned byte values from the stream.
read_double(position)Read a single double value from the stream.
read_double_array(position, count)Reads an array of double values from the stream.
read_float(position)Read a single float value from the stream.
read_float_array(position, count)Reads an array of float values from the stream.
read_long(position)Read unsigned long value from the stream.
read_long_array(position, count)Reads an array of ulong values from the stream.
read_rational(position)Read a single rational number value from the stream.
read_rational_array(position, count)Reads an array of rational values from the stream.
read_s_byte(position)Reads signed byte data from the stream.
read_s_byte_array(position, count)Reads an array of signed byte values from the stream.
read_s_int(position)Read signed integer value from the stream.
read_s_int_array(position, count)Reads an array of signed integer values from the stream.
read_s_rational(position)Read a single signed rational number value from the stream.
read_s_rational_array(position, count)Reads an array of signed rational values from the stream.
read_s_short(position)Read signed short value from the stream.
read_s_short_array(position, count)Reads an array of signed short values from the stream.
read_u_int(position)Read unsigned integer value from the stream.
read_u_int_array(position, count)Reads an array of unsigned integer values from the stream.
read_u_long(position)Read unsigned long value from the stream.
read_u_long_array(position, count)Reads an array of ulong values from the stream.
read_u_short(position)Read unsigned short value from the stream.
read_u_short_array(position, count)Reads an array of unsigned integer values from the stream.
to_stream_container(start_position)Converts the underlying data to the stream container.

Constructor: TiffStreamReader(data)

 TiffStreamReader(data) 

Initializes a new instance of the TiffStreamReader class.

Parameters:

ParameterTypeDescription
databyteThe byte array data.

Constructor: TiffStreamReader(data, start_index)

 TiffStreamReader(data, start_index) 

Initializes a new instance of the TiffStreamReader class.

Parameters:

ParameterTypeDescription
databyteThe byte array data.
start_indexintThe start index into data.

Constructor: TiffStreamReader(data, start_index, data_length)

 TiffStreamReader(data, start_index, data_length) 

Initializes a new instance of the TiffStreamReader class.

Parameters:

ParameterTypeDescription
databyteThe byte array data.
start_indexintThe start index into data.
data_lengthintLength of the data.

Constructor: TiffStreamReader(stream_container)

 TiffStreamReader(stream_container) 

Initializes a new instance of the TiffStreamReader class.

Parameters:

ParameterTypeDescription
stream_containerStreamContainerThe stream container.

Method: read_bytes(array, array_index, position, count)

 read_bytes(array, array_index, position, count) 

Reads an array of byte values from the stream.

Parameters:

ParameterTypeDescription
arraybyteThe array to fill.
array_indexintThe array index to start putting values to.
positionlongThe stream position to read from.
countlongThe elements count to read.

Returns

TypeDescription
longThe array of byte values.

Method: read_bytes(position, count)

 read_bytes(position, count) 

Reads an array of unsigned byte values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
byteThe array of unsigned byte values.

Method: read_double(position)

 read_double(position) 

Read a single double value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
doubleThe single double value.

Method: read_double_array(position, count)

 read_double_array(position, count) 

Reads an array of double values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
doubleThe array of double values.

Method: read_float(position)

 read_float(position) 

Read a single float value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
floatThe single float value.

Method: read_float_array(position, count)

 read_float_array(position, count) 

Reads an array of float values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
floatThe array of float values.

Method: read_long(position)

 read_long(position) 

Read unsigned long value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
longAn unsigned short value.

Method: read_long_array(position, count)

 read_long_array(position, count) 

Reads an array of ulong values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
longThe ulong array.

Method: read_rational(position)

 read_rational(position) 

Read a single rational number value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
TiffRationalThe rational number.

Method: read_rational_array(position, count)

 read_rational_array(position, count) 

Reads an array of rational values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
TiffRational[]The array of rational values.

Method: read_s_byte(position)

 read_s_byte(position) 

Reads signed byte data from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
sbyteThe signed byte value.

Method: read_s_byte_array(position, count)

 read_s_byte_array(position, count) 

Reads an array of signed byte values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
sbyteThe array of signed byte values.

Method: read_s_int(position)

 read_s_int(position) 

Read signed integer value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
intA signed integer value.

Method: read_s_int_array(position, count)

 read_s_int_array(position, count) 

Reads an array of signed integer values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
intThe array of signed integer values.

Method: read_s_rational(position)

 read_s_rational(position) 

Read a single signed rational number value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
TiffSRationalThe signed rational number.

Method: read_s_rational_array(position, count)

 read_s_rational_array(position, count) 

Reads an array of signed rational values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
TiffSRational[]The array of signed rational values.

Method: read_s_short(position)

 read_s_short(position) 

Read signed short value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
shortA signed short value.

Method: read_s_short_array(position, count)

 read_s_short_array(position, count) 

Reads an array of signed short values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
shortThe array of signed short values.

Method: read_u_int(position)

 read_u_int(position) 

Read unsigned integer value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
uintAn unsigned integer value.

Method: read_u_int_array(position, count)

 read_u_int_array(position, count) 

Reads an array of unsigned integer values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
uintThe array of unsigned integer values.

Method: read_u_long(position)

 read_u_long(position) 

Read unsigned long value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
ulongAn unsigned short value.

Method: read_u_long_array(position, count)

 read_u_long_array(position, count) 

Reads an array of ulong values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
ulongThe ulong array.

Method: read_u_short(position)

 read_u_short(position) 

Read unsigned short value from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.

Returns

TypeDescription
ushortAn unsigned short value.

Method: read_u_short_array(position, count)

 read_u_short_array(position, count) 

Reads an array of unsigned integer values from the stream.

Parameters:

ParameterTypeDescription
positionlongThe position to read from.
countlongThe elements count.

Returns

TypeDescription
ushortThe array of unsigned integer values.

Method: to_stream_container(start_position)

 to_stream_container(start_position) 

Converts the underlying data to the stream container.

Parameters:

ParameterTypeDescription
start_positionlongThe start position to start conversion from.

Returns

TypeDescription
StreamContainerThe StreamContainer with converted data.