Spinnaker C++
4.0.0.116
Public Member Functions | Static Public Member Functions | List of all members
ImageList Class Reference
Inheritance diagram for ImageList:
IImageList

Public Member Functions

 ImageList (void)
 Default constructor. More...
 
virtual ~ImageList (void)
 Virtual destructor. More...
 
 ImageList (const ImageList &iface)
 Copy constructor. More...
 
ImageListoperator= (const ImageList &iface)
 Assignment operator. More...
 
ImagePtr operator[] (unsigned int index)
 Array subscription operators. More...
 
const ImagePtr operator[] (unsigned int index) const
 
void Release ()
 
unsigned int GetSize () const
 Returns the size of the image list. More...
 
ImagePtr GetByIndex (unsigned int index) const
 Returns a pointer to an image object at the "index". More...
 
ImagePtr GetByPixelFormat (PixelFormatEnums pixelFormat) const
 Returns a pointer to the first image object with the pixel format from the list. More...
 
void Clear ()
 Clears the list of images and destroys their corresponding reference counted objects. More...
 
void Add (ImagePtr image)
 Adds a copy of an image object. More...
 
void RemoveByIndex (unsigned int index)
 Removes an image at "index" and destroys its corresponding reference counted object. More...
 
void RemoveByPixelFormat (PixelFormatEnums pixelFormat)
 Removes an image object with the image pixel format from the list. More...
 
void Append (const ImageList &list)
 Appends a copy of the image list. More...
 
void Save (const char *filename)
 Saves an image list as an object to a file. More...
 
- Public Member Functions inherited from IImageList
virtual ~IImageList (void)
 

Static Public Member Functions

static ImageList Load (const char *filename)
 Creates an image list object from file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IImageList
 IImageList ()
 
 IImageList (const IImageList &)
 
IImageListoperator= (const IImageList &)
 
- Protected Attributes inherited from IImageList
ImageListData * m_pImageListData
 

Constructor & Destructor Documentation

ImageList ( void  )

Default constructor.

virtual ~ImageList ( void  )
virtual

Virtual destructor.

ImageList ( const ImageList iface)

Copy constructor.

Member Function Documentation

void Add ( ImagePtr  image)
virtual

Adds a copy of an image object.

Parameters
imageAn image object to be added to this list.

Implements IImageList.

void Append ( const ImageList list)
virtual

Appends a copy of the image list.

Parameters
listAnother ImageList object, whose elements are added to this list.

Implements IImageList.

void Clear ( )
virtual

Clears the list of images and destroys their corresponding reference counted objects.

This is necessary in order to clean up the parent interface. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.

See Also
System::ReleaseInstance()

Implements IImageList.

ImagePtr GetByIndex ( unsigned int  index) const
virtual

Returns a pointer to an image object at the "index".

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters
indexThe index at which to retrieve the Image object
Returns
A pointer to an image object.

Implements IImageList.

ImagePtr GetByPixelFormat ( PixelFormatEnums  pixelFormat) const
virtual

Returns a pointer to the first image object with the pixel format from the list.

This function will return a NULL ImagePtr if no matching pixel format is found.

Parameters
pixelFormatThe pixel format of the Image object to retrieve
Returns
A pointer to an image object.

Implements IImageList.

unsigned int GetSize ( ) const
virtual

Returns the size of the image list.

The size is the number of Image objects stored in the list.

Returns
An integer that represents the list size.

Implements IImageList.

static ImageList Load ( const char *  filename)
static

Creates an image list object from file.

Parameters
filenameName of the file to load an image object from.
See Also
Save()
ImageList& operator= ( const ImageList iface)

Assignment operator.

ImagePtr operator[] ( unsigned int  index)
virtual

Array subscription operators.

Implements IImageList.

const ImagePtr operator[] ( unsigned int  index) const
void Release ( )
virtual

Implements IImageList.

void RemoveByIndex ( unsigned int  index)
virtual

Removes an image at "index" and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters
indexThe index at which to remove the Image object

Implements IImageList.

void RemoveByPixelFormat ( PixelFormatEnums  pixelFormat)
virtual

Removes an image object with the image pixel format from the list.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified pixel format.

Parameters
pixelFormatThe pixel format of the image object to remove

Implements IImageList.

void Save ( const char *  filename)
virtual

Saves an image list as an object to a file.

Parameters
filenameName of the file to save the current image list object to. It is recommended to use the file extension 'sil'.
See Also
Load()

Implements IImageList.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference