PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
CDIndexList Class Referenceabstract

Represents a collection of CD track indexes. More...

#include <PrimoBurnerAPI.h>

Public Member Functions

virtual void add (int32_t item)=0
 Adds a new CD index to the list. More...
 
virtual int32_t at (int32_t index) const =0
 Gets a CD index position, in blocks, relative to the track start. More...
 
virtual void clear ()=0
 Removes all items from the list.
 
virtual int32_t count () const =0
 Gets the number of elements contained in the list. More...
 
virtual int32_t indexOf (int32_t item) const =0
 Determines the index of a specific element in the list. More...
 
virtual bool_t insert (int32_t index, int32_t item)=0
 Inserts an element at the specified position in the list. More...
 
virtual bool_t remove (int32_t index)=0
 Removes the element at the specified index. More...
 
virtual bool_t setAt (int32_t index, int32_t item)=0
 Sets the position of an existing CD index. More...
 

Detailed Description

Represents a collection of CD track indexes.

An index is defined as blocks relative to the track start.

See Also
CDTrack::indexes

Member Function Documentation

virtual void add ( int32_t  item)
pure virtual

Adds a new CD index to the list.

You can add up to 98 indexes per CD track.

Parameters
itemSpecifies the CD index, in blocks, relative to the track start.
virtual int32_t at ( int32_t  index) const
pure virtual

Gets a CD index position, in blocks, relative to the track start.

Parameters
indexThe zero-based index of the element to get.
Returns
The requested item (CD Index) or -1 if the index parameter is out of range.
virtual int32_t count ( ) const
pure virtual

Gets the number of elements contained in the list.

Returns
number of elements
virtual int32_t indexOf ( int32_t  item) const
pure virtual

Determines the index of a specific element in the list.

Parameters
itemThe CD index, in blocks, relative to the track start.
Returns
The index of item if found in the list; otherwise, -1.
virtual bool_t insert ( int32_t  index,
int32_t  item 
)
pure virtual

Inserts an element at the specified position in the list.

Parameters
indexThe zero-based index in the list where the new element should be inserted.
itemThe CD index position that should be inserted in the list.
Returns
TRUE if the operation is successful, FALSE otherwise
virtual bool_t remove ( int32_t  index)
pure virtual

Removes the element at the specified index.

Parameters
indexThe zero-based index of the item to remove.
Returns
TRUE if the operation is successful, FALSE otherwise
virtual bool_t setAt ( int32_t  index,
int32_t  item 
)
pure virtual

Sets the position of an existing CD index.

The method does nothing if the "index" parameter is out of range.

Parameters
indexThe zero-based index of the element to get or set.
itemThe CD index, in blocks, relative to the track start.
Returns
TRUE if the operation is successful, FALSE otherwise