Label_Patcher.hh

Go to the documentation of this file.

/*  Label_Patcher

PIRL CVS ID: Label_Patcher.hh,v 1.5 2020/02/14 01:17:17 schaller Exp

Copyright (C) 2009-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#ifndef _LABEL_PATCHER_
#define _LABEL_PATCHER_

#include    "PVL.hh"

#include    <iosfwd>
#include    <string>

#ifndef MODULE_VERSION
#define _VERSION_ " "
#else
#define _VERSION_ " v" MODULE_VERSION " "
#endif

void usage (const char* const program);


namespace UA
{
namespace HiRISE
{
class Label_Patcher
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char
    * const PDS_VERSION_ID_PARAMETER,
    * const OBSERVATION_ID_PARAMETER;

static const char
    * const LABEL_RECORDS_PARAMETER,
    DATA_LOCATION_PREFIX;

static const char
    * const LOOKUP_CONVERSION_TABLE;

static const char
    * const DATABASE_TYPE,
    * const TYPE_PARAMETER,
    * const SERVER_PARAMETER,
    * const HOST_PARAMETER,
    * const USER_PARAMETER,
    * const PASSWORD_PARAMETER,
    * const CATALOG_PARAMETER,
    * const TABLE_PARAMETER;

#ifndef DEFAULT_CONFIGURATION_FILENAME
#define DEFAULT_CONFIGURATION_FILENAME  "Database.conf"
#endif

#ifndef DEFAULT_DATABASE_HOST
#define DEFAULT_DATABASE_HOST           ""
#endif

#ifndef DEFAULT_DATABASE_CATALOG
#define DEFAULT_DATABASE_CATALOG        "HiRISE"
#endif

#ifndef DEFAULT_DATABASE_TABLE
#define DEFAULT_DATABASE_TABLE          "EDR_Products"
#endif

static const char
    * const OBSERVATION_ID_FIELD;

#ifndef BACKUP_FILENAME_SUFFIX
#define BACKUP_FILENAME_SUFFIX          "-backup"
#endif

static const int
    SUCCESS,

    //  Command line syntax.
    BAD_SYNTAX,

    //  Configuration.
    CONFIGURATION_FAILURE,

    //  Database.
    DATABASE_ERROR,

    //  Software / data problem.
    INVALID_ARGUMENT,
    LENGTH_ERROR,
    UNDERFLOW_ERROR,
    OUT_OF_RANGE,
    LOGIC_ERROR,

    //  IO.
    NO_INPUT_FILE,
    NO_OUTPUT_FILE,
    NO_PVL_FILE,
    IO_FAILURE,

    //  PVL.
    PVL_ERROR,

    //  Unknown?
    UNKNOWN_ERROR;

/*==============================================================================
    Data members:
*/
bool
    Backup,
    Force,
    Verbose;

std::string
    Input_Pathname;
std::ifstream
    *Input_File;

idaeim::PVL::Aggregate
    *PDS_Label;
idaeim::PVL::Lister
    PDS_Label_Lister;
idaeim::PVL::Parameter
    *Label_Size_Parameter;

std::string
    Observation_ID;

struct Database_Configuration
    {
    std::string
        Configuration_Pathname,
        Server,
        Host,
        User,
        Password,
        Catalog,
        Table;
    }
    Database_Configuration_Values;

/*==============================================================================
    Constructor
*/
Label_Patcher
    (
    int     count,
    char**  arguments
    );

private:
Label_Patcher () {}

public:
/*==============================================================================
    Manipulators
*/
idaeim::PVL::Parameter*
label_parameter (const std::string& pathname);

void
configure_database ();

void
connect_to_database ();

std::string
database_field_value (const std::string& field, const std::string& key,
                        const std::string& table = "");

std::string
database_configuration_report ();

std::string
database_connection_report ();

void
disconnect_from_database ();

int
apply_patch ();

};  //  Class Label_Patcher


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