Bial::MultiImage Class Reference

The MultiImage class may have only one of the following image types: int, float, Color, or RealColor. More...

#include <MultiImage.hpp>

Collaboration diagram for Bial::MultiImage:

Public Member Functions
	MultiImage ()
	Basic Constructor. More...
	MultiImage (const Image< int > &img)
	Basic Constructor. Makes a copy of the given image. More...
	MultiImage (const Image< float > &img)
	MultiImage (const Image< Color > &img)
	MultiImage (const Image< RealColor > &img)
	MultiImage (const MultiImage &mimg)
	Copy Constructor. More...
	MultiImage (MultiImage &&mimg)
	Move Constructor. More...
	~MultiImage ()
	Destructor. More...
MultiImage &	operator= (const MultiImage &mimg)
	Copy assign operator. More...
MultiImage &	operator= (MultiImage &&mimg)
	Move assign operator. More...
const MultiImageType &	Type () const
	Returns a reference the current image type. More...
Image< int > &	IntImage () const
	Returns a reference to the integer image. More...
Image< float > &	FltImage () const
	Returns a reference to the float image. More...
Image< Color > &	ClrImage () const
	Returns a reference to the Color image. More...
Image< RealColor > &	RclImage () const
	Returns a reference to the RealColor image. More...

Detailed Description

The MultiImage class may have only one of the following image types: int, float, Color, or RealColor.

Definition at line 34 of file MultiImage.hpp.

Constructor & Destructor Documentation

Bial::MultiImage::MultiImage

(

)

Basic Constructor.

Date

2016/Sep/29

Parameters

none.

Returns

none.

Warning

none.

Bial::MultiImage::MultiImage

(

const Image< int > &

img

)

Basic Constructor. Makes a copy of the given image.

Date

2016/Sep/29

Parameters

img	Input image.

Returns

none.

Warning

none.

Bial::MultiImage::MultiImage

(

const Image< float > &

img

)

Bial::MultiImage::MultiImage

(

const Image< Color > &

img

)

Bial::MultiImage::MultiImage

(

const Image< RealColor > &

img

)

Bial::MultiImage::MultiImage

(

const MultiImage &

mimg

)

Copy Constructor.

Date

2016/Sep/29

Parameters

mimg	Input multi image.

Returns

none.

Warning

none.

Bial::MultiImage::MultiImage

(

MultiImage &&

mimg

)

Move Constructor.

Date

2016/Sep/29

Parameters

mimg	Input multi image.

Returns

none.

Warning

none.

Bial::MultiImage::~MultiImage

(

)

Destructor.

Date

2016/Sep/29

Parameters

none.

Returns

none.

Warning

none.

Member Function Documentation

Image< Color >& Bial::MultiImage::ClrImage

(

)

const

Returns a reference to the Color image.

Date

2016/Sep/29

Parameters

none.

Returns

A reference to the Color image.

Warning

Does not verify if Color image exists.

Image< float >& Bial::MultiImage::FltImage

(

)

const

Returns a reference to the float image.

Date

2016/Sep/29

Parameters

none.

Returns

A reference to the float image.

Warning

Does not verify if float image exists.

Image< int >& Bial::MultiImage::IntImage

(

)

const

Returns a reference to the integer image.

Date

2016/Sep/29

Parameters

none.

Returns

A reference to the integer image.

Warning

Does not verify if integer image exists.

MultiImage& Bial::MultiImage::operator=

(

const MultiImage &

mimg

)

Copy assign operator.

Date

2016/Sep/29

Parameters

mimg	Input multi image.

Returns

A copy of the input multi image.

Warning

none.

MultiImage& Bial::MultiImage::operator=

(

MultiImage &&

mimg

)

Move assign operator.

Date

2016/Sep/29

Parameters

mimg	Input multi image.

Returns

A new multi image based on input multi image elements.

Warning

none.

Image< RealColor >& Bial::MultiImage::RclImage

(

)

const

Returns a reference to the RealColor image.

Date

2016/Sep/29

Parameters

none.

Returns

A reference to the RealColor image.

Warning

Does not verify if RealColor image exists.

const MultiImageType& Bial::MultiImage::Type

(

)

const

Returns a reference the current image type.

Date

2016/Sep/29

Parameters

none.

Returns

A reference the current image type.

Warning

none.

---

The documentation for this class was generated from the following file:

• bial/inc/MultiImage.hpp