RmpFault.h

Go to the documentation of this file.

/*
  COPYRIGHT (c) 2014 SEGWAY Inc.

  Software License Agreement:

  The software supplied herewith by Segway Inc. (the "Company") for its 
  RMP Robotic Platforms is intended and supplied to you, the Company's 
  customer, for use solely and exclusively with Segway products. The 
  software is owned by the Company and/or its supplier, and is protected 
  under applicable copyright laws.  All rights are reserved. Any use in 
  violation of the foregoing restrictions may subject the user to criminal
  sanctions under applicable laws, as well as to civil liability for the 
  breach of the terms and conditions of this license. The Company may 
  immediately terminate this Agreement upon your use of the software with 
  any products that are not Segway products.

  You shall indemnify, defend and hold the Company harmless from any claims, 
  demands, liabilities or expenses, including reasonable attorneys fees, incurred 
  by the Company as a result of any claim or proceeding against the Company 
  arising out of or based upon: 

  (i) The combination, operation or use of the software by you with any hardware, 
      products, programs or data not supplied or approved in writing by the Company, 
      if such claim or proceeding would have been avoided but for such combination, 
      operation or use.

  (ii) The modification of the software by or on behalf of you.

  (iii) Your use of the software.

  THIS SOFTWARE IS PROVIDED IN AN "AS IS" CONDITION. NO WARRANTIES,
  WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED
  TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
  IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
  CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
*/

#ifndef RMP_FAULT_H
#define RMP_FAULT_H

#include <cstdint>
#include <string>
#include <vector>
#include <memory>

#include <RmpUserDefinedFeedbackType.h>

namespace segway
{
  static const uint32_t NO_FAULT = 0x00000000;
  
  typedef std::vector<std::string> FaultStatusDescription;

  enum FaultGroup
  {
    TRANSIENT = 0,
    CRITICAL,
    COMM,
    SENSORS,
    BSA,
    MCU,
    ARCHITECTURE,
    INTERNAL
  };

  class RmpFault;
  
  class FaultPacking
  {
    friend class RmpFault;

  public:
    FaultPacking(const FaultPacking& rOther)
      : m_Shift(rOther.m_Shift)
      , m_Mask(rOther.m_Mask)
      , m_Group(rOther.m_Group)
    {}

    FaultPacking& operator=(const FaultPacking& rOther)
    {
      m_Shift = rOther.m_Shift;
      m_Mask = rOther.m_Mask;
      m_Group = rOther.m_Group;
    }

    const uint32_t& GetShift() const;

    const uint32_t& GetMask() const;

    const FaultGroup& GetGroup() const;

  private:
    FaultPacking(uint32_t shift, uint32_t mask, FaultGroup group)
      : m_Shift(shift)
      , m_Mask(mask)
      , m_Group(group)
    {}
  
    FaultPacking()
    {}

    uint32_t m_Shift;

    uint32_t m_Mask;

    FaultGroup m_Group;
  };

  typedef std::vector<FaultPacking> FaultPackingList;
  typedef std::vector<UserDefinedFeedbackType> FeedbackTypeList;
  typedef std::vector<std::string> FaultDecodeList;

  class RmpFault
  {
  public:
    static const FeedbackTypeList& GetFaultFeedbackEntryList();

    static const FaultPackingList& GetFaultPackingList(UserDefinedFeedbackType feedbackType);

    static const FaultDecodeList& GetFaultDecodeList(FaultGroup faultGroup);

  private:
    RmpFault();

    RmpFault(const RmpFault&);

    RmpFault& operator=(const RmpFault&);

    ~RmpFault();

    struct Impl;
    std::unique_ptr<Impl> m_pImpl;
  };
  
} // namespace segway

#endif // RMP_FAULT_H