CRioMMIndex Class Reference

#include <RioMMIndex.h>

Data Structures
class	FileSection
class	SlideSection
Public Member Functions
	CRioMMIndex (RioBlock, int, int, const char *)
	~CRioMMIndex (void)
bool	InsertFile (const char *, RioBlock)
bool	InsertSlide (int, int, RioBlock, RioBlock)
bool	GetContext (RioBlock, TString &, int *, int *, RioBlock *) const
ContextResult	ResetContext (RioBlock)
ContextResult	UpdateContext (RioBlock, TString &, int *, int *, RioBlock *)
const char *	GetArchiveName (void) const
int	GetMajor (void) const
int	GetMinor (void) const
bool	IsValid (void) const
Private Attributes
int	number_of_files
int	number_of_slides
int	major
int	minor
TString	archive_name
FileSection *	first_file
FileSection *	last_file
FileSection *	current_file
SlideSection *	current_slide

---

Detailed Description

Definition at line 37 of file RioMMIndex.h.

---

Constructor & Destructor Documentation

CRioMMIndex::CRioMMIndex	(	RioBlock	idcs,
		int	maj,
		int	min,
		const char *	arch
	)

Definition at line 144 of file RioMMIndex.cpp.

{
    #ifdef RIO_DEBUG2
    RioErr << "[RioMMIndex]: Entrei no construtor: idcs=" << idcs << endl;
    #endif
    
    //    number_of_indices = idcs;
    major             = maj;
    minor             = min;
    archive_name      = arch;
    number_of_files   = 0;
    number_of_slides  = 0;
    first_file        = NULL;
    last_file         = NULL;
    current_file      = NULL;
    current_slide     = NULL;

    #ifdef RIO_DEBUG2
    RioErr << "[RioMMIndex]: Saindo do construtor" << endl;
    #endif
}

CRioMMIndex::~CRioMMIndex

(

void

)

Definition at line 166 of file RioMMIndex.cpp.

{
    if( first_file )
        delete first_file;
}

---

Member Function Documentation

const char * CRioMMIndex::GetArchiveName

(

void

)

const

Definition at line 515 of file RioMMIndex.cpp.

{
    return (const char *)archive_name;
}

bool CRioMMIndex::GetContext	(	RioBlock	idx,
		TString &	fname,
		int *	sld,
		int *	cmd,
		RioBlock *	cidx
	)			const

Definition at line 320 of file RioMMIndex.cpp.

{
    FileSection  * temp_file;
    SlideSection * temp_slide;

    if( number_of_files == 0 || idx < first_file->GetIndex( ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Index outside of slides range" << endl;
        #endif
        return false;
    }

    for( temp_file = first_file;
         temp_file->GetNextFile( ) != NULL;
         temp_file = temp_file->GetNextFile( ) )
    {
        if( idx < temp_file->GetNextFile( )->GetIndex( ) )
        {
            break;
        }
    }

    if( temp_file->GetFirstSlide( ) == NULL ||
        idx < temp_file->GetFirstSlide( )->GetIndex( ) )
    {
        return false;
    }

    for( temp_slide = temp_file->GetFirstSlide( );
         temp_slide->GetNextSlide( ) != NULL;
         temp_slide = temp_slide->GetNextSlide( ) )
    {
        if( idx < temp_slide->GetNextSlide( )->GetIndex( ) )
        {
            break;
        }
    }

    fname = temp_file->GetFileName( );
    *sld = temp_slide->GetSlideNumber( );
    *cmd = temp_slide->GetCommands( );
    *cidx = temp_slide->GetFirstCommandIndex( );
    return true;
}

int CRioMMIndex::GetMajor

(

void

)

const

Definition at line 520 of file RioMMIndex.cpp.

{
    return major;
}

int CRioMMIndex::GetMinor

(

void

)

const

Definition at line 525 of file RioMMIndex.cpp.

{
    return minor;
}

bool CRioMMIndex::InsertFile	(	const char *	fname,
		RioBlock	idx
	)

Definition at line 172 of file RioMMIndex.cpp.

{
    FileSection * new_file,
                * temp_file;

    new_file = new FileSection( fname, idx );
    /* Cannot allocate structure */
    if( new_file == NULL )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Not enough memory" << endl;
        #endif
        return false;
    }

    /* First insertion */
    if( number_of_files == 0 )
    {
        first_file = last_file = new_file;
    }
    /* Insertion at the end - most common case */
    else if( idx > last_file->GetIndex( ) )
    {
        last_file->SetNextFile( new_file );
        last_file = new_file;
    }
    /* Insertion at the beginning - not so common case */
    else if( idx < first_file->GetIndex( ) )
    {
        new_file->SetNextFile( first_file );
        first_file = new_file;
    }
    /* Insertion in the middle - unexpected, but allowed case */
    else
    {
        for( temp_file = first_file;
             temp_file->GetNextFile( ) != NULL;
             temp_file = temp_file->GetNextFile( ) )
        {
            if( idx < temp_file->GetNextFile( )->GetIndex( ) )
            {
                new_file->SetNextFile( temp_file->GetNextFile( ) );
                temp_file->SetNextFile( new_file );
                break;
            }
        }
        if( temp_file->GetNextFile( ) == NULL )
        {
            RioErr << "RioMMIndex - Unknown error" << endl;
            delete new_file;
            return false;
        }
    }

    number_of_files++;
    return true;
}

bool CRioMMIndex::InsertSlide	(	int	sld,
		int	cmd,
		RioBlock	cidx,
		RioBlock	idx
	)

Definition at line 230 of file RioMMIndex.cpp.

{
    FileSection  * temp_file;
    SlideSection * new_slide,
                 * temp_slide;

    /* Insertion outside files */
    if( number_of_files == 0 || idx < first_file->GetIndex( ) )
    {
        RioErr << "RioMMIndex - Slides must be inserted within a file" << endl;
        return false;
    }

    /* Insertion at last file - most common case */
    if( idx > last_file->GetIndex( ) )
    {
        temp_file = last_file;
    }
    /* Insertion in the middle - unexpected, but allowed case */
    else
    {
        for( temp_file = first_file;
             temp_file->GetNextFile( ) != NULL;
             temp_file = temp_file->GetNextFile( ) )
        {
            if( idx < temp_file->GetNextFile( )->GetIndex( ) )
            {
                break;
            }
        }
    }

    /* Create new slide section */
    new_slide = new SlideSection( sld, idx, cmd, cidx );
    /* Cannot allocate structure */
    if( new_slide == NULL )
    {
        RioErr << "RioMMIndex - Not enough memory" << endl;
        return false;
    }

    /* First insertion in the file */
    if( temp_file->GetFirstSlide( ) == NULL )
    {
        temp_file->SetFirstSlide( new_slide );
        temp_file->SetLastSlide( new_slide );
    }
    /* Insertion at the end of the file - most common case */
    else if( idx > temp_file->GetLastSlide( )->GetIndex( ) )
    {
        temp_file->GetLastSlide( )->SetNextSlide( new_slide );
        temp_file->SetLastSlide( new_slide );
    }
    /* Insertion at the beginning - not so common case */
    else if( idx < temp_file->GetFirstSlide( )->GetIndex( ) )
    {
        new_slide->SetNextSlide( temp_file->GetFirstSlide( ) );
        temp_file->SetFirstSlide( new_slide );
    }
    /* Insertion in the middle - unexpected, but allowed case */
    else
    {
        for( temp_slide = temp_file->GetFirstSlide( );
             temp_slide->GetNextSlide( ) != NULL;
             temp_slide = temp_slide->GetNextSlide( ) )
        {
            if( idx < temp_slide->GetNextSlide( )->GetIndex( ) )
            {
                new_slide->SetNextSlide( temp_slide->GetNextSlide( ) );
                temp_slide->SetNextSlide( new_slide );
                break;
            }
        }
        if( temp_slide->GetNextSlide( ) == NULL )
        {
            RioErr << "RioMMINDEX - Unknown error" << endl;
            delete new_slide;
            return false;
        }
    }

    number_of_slides++;
    return true;
}

bool CRioMMIndex::IsValid

(

void

)

const

Definition at line 530 of file RioMMIndex.cpp.

{
    FileSection * temp_file;

    if( number_of_files < 1 )
        return false;

    for( temp_file = first_file;
         temp_file->GetNextFile( ) != NULL;
         temp_file = temp_file->GetNextFile( ) )
    {
        if( temp_file->GetFirstSlide( ) == NULL )
            return false;
    }

    return true;
}

ContextResult CRioMMIndex::ResetContext

(

RioBlock

idx

)

Definition at line 372 of file RioMMIndex.cpp.

{
    FileSection  * temp_file;
    SlideSection * temp_slide;

    if( number_of_files == 0 || idx < first_file->GetIndex( ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Index outside of slides range" << endl;
        #endif
        return CONTEXT_FAILED;
    }

    for( temp_file = first_file;
         temp_file->GetNextFile( ) != NULL;
         temp_file = temp_file->GetNextFile( ) )
    {
        if( idx < temp_file->GetNextFile( )->GetIndex( ) )
        {
            break;
        }
    }

    if( temp_file->GetFirstSlide( ) == NULL ||
        idx < temp_file->GetFirstSlide( )->GetIndex( ) )
    {
        return CONTEXT_FAILED;
    }

    for( temp_slide = temp_file->GetFirstSlide( );
         temp_slide->GetNextSlide( ) != NULL;
         temp_slide = temp_slide->GetNextSlide( ) )
    {
        if( idx < temp_slide->GetNextSlide( )->GetIndex( ) )
        {
            break;
        }
    }

    current_file  = temp_file;
    current_slide = temp_slide;
    return CONTEXT_CHANGED;
}

ContextResult CRioMMIndex::UpdateContext	(	RioBlock	idx,
		TString &	fname,
		int *	sld,
		int *	cmd,
		RioBlock *	cidx
	)

Definition at line 422 of file RioMMIndex.cpp.

{
    FileSection  * temp_file;
    SlideSection * temp_slide;
    ContextResult result;

    if( current_file == NULL )
    {
        result = ResetContext( idx );
        if( result == CONTEXT_CHANGED )
        {
            fname = current_file->GetFileName( );
            *sld  = current_slide->GetSlideNumber( );
            *cmd  = current_slide->GetCommands( );
            *cidx = current_slide->GetFirstCommandIndex( );
        }
        return result;
    }

    if( number_of_files == 0 || idx < first_file->GetIndex( ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Index outside of slides range" << endl;
        #endif
        return CONTEXT_FAILED;
    }

    // If the index is not before the current file
    // forward processing - the most common case for sequential access
    if( idx >= current_file->GetIndex( ) )
    {
        temp_file = current_file;
    }
    else
    {
        temp_file = first_file;
    }

    for( ; temp_file->GetNextFile( ) != NULL;
           temp_file = temp_file->GetNextFile( ) )
    {
        if( idx < temp_file->GetNextFile( )->GetIndex( ) )
        {
            break;
        }
    }

    if( temp_file->GetFirstSlide( ) == NULL ||
        idx < temp_file->GetFirstSlide( )->GetIndex( ) )
    {
        #ifdef RIO_DEBUG2
        RioErr << "Found a file with no slides" << endl;
        #endif
        return CONTEXT_FAILED;
    }

    // If the index is not before the current slide
    // forward processing - the most common case for sequential access
    if( temp_file == current_file && idx >= current_slide->GetIndex( ) )
    {
        temp_slide = current_slide;
    }
    else
    {
        temp_slide = temp_file->GetFirstSlide( );
    }

    for( ; temp_slide->GetNextSlide( ) != NULL;
           temp_slide = temp_slide->GetNextSlide( ) )
    {
        if( idx < temp_slide->GetNextSlide( )->GetIndex( ) )
        {
            break;
        }
    }

    fname = temp_file->GetFileName( );
    *sld  = temp_slide->GetSlideNumber( );
    *cmd  = temp_slide->GetCommands( );
    *cidx = temp_slide->GetFirstCommandIndex( );

    if( temp_file == current_file && temp_slide == current_slide )
    {
        return CONTEXT_NOTCHANGED;
    }

    current_file  = temp_file;
    current_slide = temp_slide;

    return CONTEXT_CHANGED;
}

---

Field Documentation

TString CRioMMIndex::archive_name [private]

Definition at line 91 of file RioMMIndex.h.

FileSection* CRioMMIndex::current_file [private]

Definition at line 97 of file RioMMIndex.h.

SlideSection* CRioMMIndex::current_slide [private]

Definition at line 98 of file RioMMIndex.h.

FileSection* CRioMMIndex::first_file [private]

Definition at line 93 of file RioMMIndex.h.

FileSection * CRioMMIndex::last_file [private]

Definition at line 93 of file RioMMIndex.h.

int CRioMMIndex::major [private]

Definition at line 90 of file RioMMIndex.h.

int CRioMMIndex::minor [private]

Definition at line 90 of file RioMMIndex.h.

int CRioMMIndex::number_of_files [private]

Definition at line 87 of file RioMMIndex.h.

int CRioMMIndex::number_of_slides [private]

Definition at line 88 of file RioMMIndex.h.

---

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

• RioMMIndex.h
• RioMMIndex.cpp