Channel_ID.hh

Go to the documentation of this file.

/*  Channel_ID

PIRL CVS ID: Channel_ID.hh,v 2.3 2020/02/14 00:58:12 schaller Exp

Copyright (C) 2003-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 _UA_HIRISE_CHANNEL_ID_HEADER_
#define _UA_HIRISE_CHANNEL_ID_HEADER_

#include "CCD_ID.hh"


namespace UA
{
namespace HiRISE
{
class Channel_ID
:   public CCD_ID
{
public:

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

static const unsigned int
    DEFAULT_CHANNEL_NUMBER;

/*==============================================================================
Constructors
*/
/*------------------------------------------------------------------------------
Channel_ID::Channel_ID (const u_int_32, const unsigned int, const unsigned int)
*/
Channel_ID
(
    const u_int_32 observation_id_value = DEFAULT_OBSERVATION_ID,
    const unsigned int cpmm_value = DEFAULT_CPMM_NUMBER,
    const unsigned int channel_value = DEFAULT_CHANNEL_NUMBER
);

/*------------------------------------------------------------------------------
Channel_ID::Channel_ID (const Mission_Phase, const int, ...)
*/
Channel_ID
(
    const Mission_Phase mission_phase_value,
    const int time_value = -1,
    const unsigned int cpmm_value = DEFAULT_CPMM_NUMBER,
    const unsigned int channel_value = DEFAULT_CHANNEL_NUMBER
);

/*------------------------------------------------------------------------------
Channel_ID::Channel_ID (const Mission_Phase, const unsigned int, ...)
*/
Channel_ID
(
    const Mission_Phase mission_phase_value,
    const unsigned int orbit_number_value,
    const unsigned int target_value,
    const unsigned int cpmm_value = DEFAULT_CPMM_NUMBER,
    const unsigned int channel_value = DEFAULT_CHANNEL_NUMBER
);

/*------------------------------------------------------------------------------
Channel_ID::Channel_ID (const std::string&)
*/
explicit
Channel_ID
(
    const std::string& id_text
);

/*==============================================================================
Accessors
*/
/*------------------------------------------------------------------------------
Channel_ID::channel_number ()
*/
unsigned int
channel_number () const { return Channel_Number; }

/*------------------------------------------------------------------------------
Channel_ID::channel_number (const unsigned int)
*/
Channel_ID&
channel_number
(
    const unsigned int channel_value
)
throw (Out_of_Range);

/*------------------------------------------------------------------------------
Channel_ID::channel_number (const std::string&)
*/
Channel_ID&
channel_number
(
    const std::string& channel_text
)
throw (Invalid_Argument, Out_of_Range);

/*------------------------------------------------------------------------------
Channel_ID::channel_name ()
*/
std::string
channel_name () const;

/*------------------------------------------------------------------------------
Channel_ID::channel_name (const std::string&)
*/
Channel_ID&
channel_name
(
    const std::string& channel_text
)
throw (Invalid_Argument, Out_of_Range);

/*==============================================================================
Text representation
*/
/*------------------------------------------------------------------------------
Channel_ID::text ()
*/
std::string
text () const;

/*------------------------------------------------------------------------------
Channel_ID::text (const std::string&)
*/
Channel_ID&
text
(
    const std::string& id_text
)
throw (Invalid_Argument, Out_of_Range);

/*------------------------------------------------------------------------------
Channel_ID::parse (const std::string&)
*/
std::string
parse
(
    const std::string& id_text
);

/*==============================================================================
Utility Methods
*/
/*------------------------------------------------------------------------------
Channel_ID::print (std::ostream&)
*/
std::ostream& print
(
    std::ostream& stream = std::cout
) const;

/*==============================================================================
Private Members
*/
private:

int Channel_Number;

};  //  Channel_ID class

/*==============================================================================
Utility Functions
*/
/*------------------------------------------------------------------------------
UA::HiRISE::operator<< (std::ostream&, const Channel_ID&)
*/
std::ostream& operator<<
(
    std::ostream& stream,
    const Channel_ID& channel_id
);

}   //  HiRISE namespace

}   //  UA namespace

#endif