GetSerialPortState.h

Go to the documentation of this file.

// Copyright 2015 Sensics, Inc.
//
// 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 INCLUDED_GetSerialPortState_h_GUID_6A7FD323_CCB5_4093_45E3_9BA7A2943777
#define INCLUDED_GetSerialPortState_h_GUID_6A7FD323_CCB5_4093_45E3_9BA7A2943777

// Internal Includes
// - none

// Library/third-party includes
// - none

// Standard includes
#include <string>

enum SerialPortState {
    SERIAL_INVALID,  
    SERIAL_MISSING,  
    SERIAL_BUSY,     
    SERIAL_AVAILABLE 
};

SerialPortState getSerialPortState(std::string const &port);

std::string normalizeSerialPort(std::string const &port);

void verifySerialPort(std::string const &port,
                      std::string const &origPort = std::string());

std::string normalizeAndVerifySerialPort(std::string const &port);

#endif // INCLUDED_GetSerialPortState_h_GUID_6A7FD323_CCB5_4093_45E3_9BA7A2943777