Size_2D Struct Reference

A Size_2D holds 2-dimensional size information. More...

#include <Dimensions.hh>

Inheritance diagram for Size_2D:

List of all members.

Public Member Functions
	Size_2D ()
	Constructs an empty 2D size.
	Size_2D (const unsigned int &width, const unsigned int &height)
	Constructs a specific size.
	Size_2D (const unsigned int &side)
	Constructs a size of equal width and height.
	Size_2D (const Size_2D &size)
	Constructs a size from another size.
Size_2D &	operator= (const Size_2D &size)
	Assign the size of another size to this size.
unsigned int	width () const
	Get the width of the size.
Size_2D &	width (const unsigned int &width)
	Set the width of the size.
unsigned int	height () const
	Get the height of the size.
Size_2D &	height (const unsigned int &height)
	Set the height of the size.
unsigned long	area () const
	Get the area of this size.
Public Attributes
unsigned int	Width
	The width of the 2D size.
unsigned int	Height
	The height of the 2D size.

---

Detailed Description

A Size_2D holds 2-dimensional size information.

Author:

Bradford Castalia, UA/PIRL

Version:

1.7

---

Constructor & Destructor Documentation

Size_2D

(

)

Constructs an empty 2D size.

Both width and height are zero.

Referenced by Rectangle::size().

Size_2D	(	const unsigned int &	width,
		const unsigned int &	height
	)

Constructs a specific size.

Parameters:

width	The width of the size.
height	The height of the size.

Size_2D

(

const unsigned int &

side )

Constructs a size of equal width and height.

Parameters:

side	The length of each side. Both width and height will be set to this value.

Size_2D

(

const Size_2D &

size )

Constructs a size from another size.

Parameters:

size	A Size_2D to be copied.

---

Member Function Documentation

Size_2D & operator=

(

const Size_2D &

size )

Assign the size of another size to this size.

Parameters:

size	A Size_2D to have its values assigned to this size.

unsigned int width

(

)

const [inline]

Get the width of the size.

Returns:

The width of the size.

References Size_2D::Width.

Referenced by Rectangle::size().

Size_2D& width

(

const unsigned int &

width )

[inline]

Set the width of the size.

Parameters:

width

The width of the size.

Returns:

This Size_2D.

References Size_2D::width(), and Size_2D::Width.

Referenced by Size_2D::width().

unsigned int height

(

)

const [inline]

Get the height of the size.

Returns:

The height of the size.

References Size_2D::Height.

Referenced by Rectangle::size().

Size_2D& height

(

const unsigned int &

height )

[inline]

Set the height of the size.

Parameters:

height

The height of the size.

Returns:

This Size_2D.

References Size_2D::height(), and Size_2D::Height.

Referenced by Size_2D::height().

unsigned long area

(

)

const [inline]

Get the area of this size.

Returns:

The area (width * height) of the size.

References Size_2D::Height, and Size_2D::Width.

Referenced by JP2_Decoder::set_resolution_and_region().

---

Member Data Documentation

unsigned int Width

The width of the 2D size.

Referenced by HiRISE_PDS_Converter::adjust_image_map_projection(), HiPrecision_PDS_Converter::adjust_image_map_projection(), Size_2D::area(), JP2_Decoder::close(), JP2_Encoder::code_block_size(), JP2_Decoder::image_region(), JP2_Encoder::image_size(), JP2_Decoder::image_width(), JP2_Encoder::incremental_flush_lines(), JP2_Encoder::needs(), JP2_Decoder::open(), JP2_Encoder::precinct_size(), JP2_Encoder::ready(), JP2_Encoder::reasons(), JP2_Decoder::rendered_width(), JP2_Decoder::set_resolution_and_region(), Rectangle::size(), Size_2D::width(), JP2_Encoder::write_codestream(), JP2_Encoder::write_header(), JP2_Decoder::write_image_data(), and Generic_PDS_Converter::write_PDS_label().

unsigned int Height

The height of the 2D size.

Referenced by HiRISE_PDS_Converter::adjust_image_map_projection(), HiPrecision_PDS_Converter::adjust_image_map_projection(), Size_2D::area(), JP2_Decoder::close(), JP2_Encoder::code_block_size(), Size_2D::height(), JP2_Decoder::image_region(), JP2_Encoder::image_size(), JP2_Encoder::incremental_flush_lines(), JP2_Encoder::needs(), JP2_Decoder::open(), JP2_Encoder::precinct_size(), JP2_Encoder::ready(), JP2_Encoder::reasons(), JP2_Decoder::rendered_height(), JP2_Decoder::set_resolution_and_region(), Rectangle::size(), JP2_Encoder::write_header(), and Generic_PDS_Converter::write_PDS_label().

---

The documentation for this struct was generated from the following files:

• Dimensions.hh
• Dimensions.cc