PDS_Data.hh

Go to the documentation of this file.

/*  PDS_Data

HiROC CVS ID: PDS_Data.hh,v 1.26 2013/03/14 21:00:43 guym Exp

Copyright (C) 2006-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 _PDS_Data_
#define _PDS_Data_

#include    "PVL.hh"

#include    <vector>


namespace UA
{
namespace HiRISE
{
//  Forward references.
class PDS_Data_Block;
class Image_Data_Block;


class PDS_Data
:   public idaeim::PVL::Aggregate
{
public:
/*==============================================================================
    Types
*/
typedef std::vector<PDS_Data_Block*>    PDS_Data_Block_List;

/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char*
    PDS_ID_PARAMETER_NAME;

static const char
    *RECORD_TYPE_PARAMETER_NAME;

static const char
    *BYTE_RECORD_TYPE;

static const char
    *FIXED_LENGTH_RECORD_TYPE;

static const char
    *LABEL_RECORDS_PARAMETER_NAME;

static const char
    *RECORD_BYTES_PARAMETER_NAME;

static const char
    *FILE_RECORDS_PARAMETER_NAME;

static const char
    *INTERCHANGE_FORMAT_PARAMETER_NAME;

static const char*
    IMAGE_DATA_BLOCK_NAME;

static const char*
    BYTES_UNITS;

static const char
    RECORD_POINTER_PARAMETER_MARKER;

/*==============================================================================
    Constructors:
*/
PDS_Data ();

PDS_Data (const idaeim::PVL::Aggregate& parameters);

PDS_Data (const idaeim::PVL::Aggregate& parameters, const std::string& detached);

explicit PDS_Data (const std::string& pathname);


/*==============================================================================
    Accessors:
*/
PDS_Data_Block_List* data_blocks
    (const char** excluded = NULL, const char** image_block_names = NULL);

enum Parameter_Class_Selection
    {
    AGGREGATE_PARAMETER  = -1,
    ANY_PARAMETER        =  0,
    ASSIGNMENT_PARAMETER =  1
    };

idaeim::PVL::Parameter*
find_parameter
    (
    const std::string&          pathname,
    bool                        case_sensitive = false,
    int                         skip = 0,
    Parameter_Class_Selection   parameter_class = ANY_PARAMETER
    )
    const;

/*==============================================================================
    Manipulators:
*/
virtual PDS_Data& parameters (const std::string& pathname);

virtual PDS_Data& parameters (const idaeim::PVL::Aggregate& parameters);

idaeim::PVL::Parameter*
remove_parameter
    (
    const std::string&          pathname,
    bool                        case_sensitive = false,
    int                         skip = 0,
    Parameter_Class_Selection   parameter_class = ANY_PARAMETER
    );

template <typename T>
bool
parameter_value
    (
    const std::string&  pathname,
    T&                  value,
    bool                case_sensitive = false,
    int                 skip = 0
    )
{
idaeim::PVL::Parameter
    *parameter =
        find_parameter (pathname, case_sensitive, skip, ASSIGNMENT_PARAMETER);
if (! parameter ||
      parameter->value ().is_Array ())
    return false;
parameter->value () = value;
return true;
}

double
numeric_value
    (
    const std::string&  pathname,
    bool                case_sensitive = false,
    int                 skip = 0
    )
    const;

std::string
string_value
    (
    const std::string&  pathname,
    bool                case_sensitive = false,
    int                 skip = 0
    )
    const;

/*==============================================================================
    Helpers
*/
static Image_Data_Block* image_data (PDS_Data_Block_List* data_block_list);

};  //  class PDS_Data


idaeim::PVL::Parameter*
find_parameter
    (
    const idaeim::PVL::Aggregate&       parameters,
    const std::string&                  pathname,
    bool                                case_sensitive = false,
    int                                 skip = 0,
    PDS_Data::Parameter_Class_Selection parameter_class
                                            = PDS_Data::ANY_PARAMETER
    );

idaeim::PVL::Parameter*
remove_parameter
    (
    idaeim::PVL::Aggregate&             parameters,
    const std::string&                  pathname,
    bool                                case_sensitive = false,
    int                                 skip = 0,
    PDS_Data::Parameter_Class_Selection parameter_class
                                            = PDS_Data::ANY_PARAMETER
    );

double numeric_value (const idaeim::PVL::Parameter& parameter);

std::string string_value (const idaeim::PVL::Parameter& parameter);

std::string absolute_pathname (const std::string& pathname);

std::string to_uppercase (const std::string& a_string);

std::string indent (std::string lines, int amount);

idaeim::PVL::Lister* label_lister ();


}   //  namespace HiRISE
}   //  namespace UA
#endif