JP2_Box.hh

Go to the documentation of this file.

/*  JP2_Box
 
HiROC CVS ID: JP2_Box.hh,v 1.4 2007/10/20 00:39:47 castalia Exp
 
Copyright (C) 2007  Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.
 
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License, version 2.1,
as published by the Free Software Foundation.
 
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
Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser 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.
*/
 
#ifndef _JP2_Box_
#define _JP2_Box_
 
#include    <string>
#include    <vector>
 
 
namespace UA
{
namespace HiRISE
{
class JP2_Box
{
public:
/*==============================================================================
    Types:
*/
typedef std::vector<JP2_Box*>   JP2_Box_List;
 
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const unsigned int
    UUID_BOX_TYPE;
static const unsigned int
    UUID_SIZE;
static const unsigned int
    UUID_INFO_BOX_TYPE;
static const unsigned int
    UUID_LIST_BOX_TYPE;

static const unsigned int
    URL_BOX_TYPE;

static const unsigned int
    XML_BOX_TYPE;

static const unsigned int
    ASSOCIATION_BOX_TYPE;

static const unsigned int
    LABEL_BOX_TYPE;

static const unsigned int
    INTELLECTUAL_PROPERTY_BOX_TYPE;
 
/*==============================================================================
    Constructors:
*/
JP2_Box ();

explicit JP2_Box (unsigned int box_type,
    const unsigned char* data = NULL, unsigned int amount = 0);

explicit JP2_Box (unsigned int box_type, const std::string& text);

virtual ~JP2_Box ();
 
/*==============================================================================
    Accessors:
*/
std::string type_name () const
    {return Type ? type_name (Type) : "";}

JP2_Box& type_name (const std::string& name);

unsigned int type_code () const
    {return Type;}

JP2_Box& type_code (unsigned int box_type);

unsigned int content_amount () const
    {return Content_Amount;}

unsigned char* content () const
    {return Content;}

JP2_Box& content (const unsigned char* data, unsigned int amount = 0);

JP2_Box& content (const std::string& text);

bool locally_owned_content () const
    {return Locally_Owned_Content;}

JP2_Box& attach_content (unsigned char* data, unsigned int amount = 0);
 
/*==============================================================================
    Manipulators:
*/
JP2_Box& append_content (const unsigned char* data, unsigned int amount);

JP2_Box& append_content (const std::string& text);
 
//------------------------------------------------------------------------------
//  Sub-boxes

JP2_Box& add (JP2_Box* sub_box);

JP2_Box& add (JP2_Box& sub_box)
    {return add (&sub_box);}

bool remove (JP2_Box* sub_box);

JP2_Box_List& sub_boxes ()
    {return Sub_Boxes;}

JP2_Box* container () const
    {return Container;}
 
/*==============================================================================
    Helpers
*/
static std::string type_name (unsigned int box_type);

static unsigned int type_code (const std::string& name);
 
/*==============================================================================
    Data members:
*/
protected:

unsigned int
    Type;

unsigned char
    *Content;

unsigned int
    Content_Amount;

bool
    Locally_Owned_Content;

JP2_Box
    *Container;

JP2_Box_List
    Sub_Boxes;
 
};  //  class JP2_Box
 
 
}   //  namespace HiRISE
}   //  namespace UA
#endif