MROSP_Header.hh

Go to the documentation of this file.

/*  HiRISE MROSP_Header

PIRL CVS ID: MROSP_Header.hh,v 1.24 2020/02/14 01:17:18 schaller Exp

Copyright (C) 2004-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 _HiRISE_MROSP_Header_
#define _HiRISE_MROSP_Header_

//  UA::HiRISE
#include    "Data_Component.hh"

#if defined (INCLUDE_PVL)
//  idaeim::PVL
#include    "PVL.hh"
#endif

#include    <iostream>

namespace UA
{
namespace HiRISE
{
/*******************************************************************************
    MROSP Header
*/
class MROSP_Header
:   public Data_Component
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char* const
    NAME;

enum Elements
    {
    Protocol_ID,
    Transaction,
    Transaction_ID,
    Data_Amount,
    Sync,
    Pad_0,
    Checksum,
    Pad_1,

    //  The total number of Elements:
    Total_Elements
    };

static const char*
    NAMES[];

static const Index
    COMPONENT_BYTES;

static const Index
    OFFSETS[];

static const u_int_8
    PROTOCOL_ID;

/*  Transaction Element bit fields:
*/
static const u_int_8
    TRANSACTION_TYPE_BIT_MASK;

enum Transaction_Type
    {
    SCIENCE     = 1,
    ENGINEERING = 2
    };

static const char*
    Transaction_Type_Names[];

static const unsigned int
    Transaction_Types;

static const u_int_8
    TRANSACTION_SEGMENTATION_BIT_MASK;

enum Transaction_Segmentation
    {
    NONE,
    START,
    MIDDLE,
    END
    };

static const char*
    Transaction_Segmentation_Names[];

static const unsigned int
    Transaction_Segmentations;

static const u_int_8
    TRANSACTION_COMPRESSED_BIT_MASK;

static const u_int_32
    SYNC;

/*==============================================================================
    Constructors
*/
MROSP_Header ();

explicit MROSP_Header (std::istream& stream);

MROSP_Header (const MROSP_Header& component, bool data_duplicate = true);

MROSP_Header& operator= (const MROSP_Header& component);

/*==============================================================================
    Accessors
*/
std::string id () const;

const char* name () const;

u_int_8 protocol_ID () const;

MROSP_Header& protocol_ID (u_int_8 ID);

u_int_8 transaction () const;

MROSP_Header& transaction (u_int_8 value);

int transaction_type () const;

MROSP_Header& transaction_type (Transaction_Type type);

int transaction_segmentation () const;

MROSP_Header& transaction_segmentation (Transaction_Segmentation segmentation);

bool transaction_compressed () const;

MROSP_Header& transaction_compressed (bool compressed);

u_int_16 transaction_ID () const;

MROSP_Header& transaction_ID (u_int_16 ID);

u_int_32 data_amount () const;

MROSP_Header& data_amount (u_int_32 amount);

u_int_32 sync () const;

MROSP_Header& sync (u_int_32 sync_pattern);

u_int_16 checksum () const;

MROSP_Header& checksum (u_int_16 value);

u_int_16 pad_0 () const;

MROSP_Header& pad_0 (u_int_16 value);

u_int_32 pad_1 () const;

MROSP_Header& pad_1 (u_int_32 value);

/*==============================================================================
    Printing
*/
std::ostream& print
    (std::ostream& stream = std::cout, bool verbose = false) const;

#if defined (INCLUDE_PVL)
/*==============================================================================
    PVL
*/
idaeim::PVL::Aggregate* PVL () const;

#endif  // defined (INCLUDE_PVL)

/*==============================================================================
    Validation
*/
bool is_valid () const;

};  //  class MROSP_Header

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