root/juggler/branches/1.0/Config/vjChunkDescDB.h

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998, 1999, 2000, 2001, 2002
 *   by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date$
 * Version:       $Revision$
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/


#ifndef _VJ_CHUNKDESCDB_H_
#define _VJ_CHUNKDESCDB_H_

#include <vjConfig.h>
#include <Config/vjChunkDesc.h>

//--------------------------------------------------------------
//: Storage class for vjChunkDescs used by the ConfigChunkDB.
//
//  A vjChunkDescDB is a container for vjChunkDescs.  Includes
//  functions to search for particular vjChunkDescs, and to read
//  and write ChunkDesc files.
//
// @author Christopher Just
// October 1997
//!PUBLIC_API:
//-----------------------------------------------------------------


class vjChunkDescDB {
private:

    //:Internal storage of vjChunkDescs
    std::vector<vjChunkDesc*> descs;

public:

    //:Default Constructor
    //!POST: Self is created with an empty vector of vjChunkDescs
    vjChunkDescDB ();


    //:Destructor
    //!POST: Self is destroyed; all memory (including contained
    //+      vjChunkDescs) is destroyed.
    ~vjChunkDescDB ();


    //:Searches for a particular vjChunkDesc
    //!RETURNS: desc - a vjChunkDesc whose token matches _token
    //!RETURNS: NULL - if no such vjChunkDesc is found
    vjChunkDesc *getChunkDesc (const std::string& _token);


    //:Inserts a vjChunkDesc
    //!ARGS: d - non-NULL pointer to vjChunkDesc
    //!POST: d is inserted into self, replacing any vjChunkDesc
    //+      with the same token.
    //!RETURNS: True - always.
    bool insert (vjChunkDesc *d);


    //:Inserts all vjChunkDescs in db
    //!ARGS: db - a non-NULL pointer to a vjChunkDescDB
    //!POST: all elements of db are inserted into self, replacing any
    //+      existing vjChunkDescs with the same token.
    void insert (vjChunkDescDB* db);
    

    //:Removes vjChunkDesc from self
    //!ARGS: _token - a non-NULL C string
    //!POST: Any vjChunkDesc in self whose token equals _token
    //+      is removed and destroyed.
    //!RETURNS: true - if a matching chunk was found
    //!RETURNS: false - if no matching chunk was found
    bool remove (const std::string& name);


    //:Removes all vjChunkDescs from self
    //!POST: All vjChunkDescs in self have been removed and
    //+      destroyed
    //!NOTE: This <b>can</b> be dangerous, if there exist
    //+      vjConfigChunks somewhere that rever to any of
    //+      the deleted vjChunkDescs.
    void removeAll ();


    //:Returns the number of vjChunkDescs in self.
    //!RETURNS: n - the number of vjChunkDescs in self.
    int size ();


    //:Writes self to out
    //!POST: A text representation of self is appended to out
    //!RETURNS: out
    //!NOTE: The output format is zero or more vjChunkDescs
    //+      followed by "end"
    friend std::ostream& operator << (std::ostream& out, vjChunkDescDB& self);


    //:Reads from in
    //!POST: vjChunkDescs read from in are appended to self.
    //+      vjChunkDescs previously in self are retained.
    //!NOTE: input format is zero or more vjChunkDescs followed
    //+      by "End" or eof.
    friend std::istream& operator >> (std::istream& in, vjChunkDescDB& self);


    //:Loads a chunkdesc file
    //!ARGS: fname - name of file to load
    //!POST: File is opened and vjChunkDescs are read and inserted
    //+      into self (using >>).
    //!RETURNS: true - if file was opened succesfully
    //!RETURNS: false - otherwise
    //!NOTE: Return value only deals with opening the file, and
    //+      true doesn't neccessarily mean no parsing errors
    //+      occurred.
    bool load (const std::string& filename, const std::string& parentfile = "");


    //:Saves a chunkdesc file
    //!ARGS: fname - name of file to load
    //!POST: File is opened and vjChunkDescs are written to it
    //+      using << operator.
    //!RETURNS: true - if file was opened succesfully
    //!RETURNS: false - otherwise
    bool save (const char *fname);

};

#endif