chain_type.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2020 by the OpenStructure authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_CHAIN_TYPE_HH
#define OST_CHAIN_TYPE_HH

#include <ost/mol/module_config.hh>
#include <ost/base.hh>
#include <ost/string_ref.hh>

#include "module_config.hh"

namespace ost { namespace mol {

// _entity_poly.type, which is more detailed. As a result it is not a 1:1
// mapping and cannot be used to to read/write mmCIF entity types accurately.

typedef enum {
  CHAINTYPE_POLY,           
  CHAINTYPE_NON_POLY,       
  CHAINTYPE_WATER,          
  CHAINTYPE_POLY_PEPTIDE_D, 
  CHAINTYPE_POLY_PEPTIDE_L, 
  CHAINTYPE_POLY_DN,        
  CHAINTYPE_POLY_RN,        
  CHAINTYPE_POLY_SAC_D,     
  CHAINTYPE_POLY_SAC_L,     
  CHAINTYPE_POLY_DN_RN,     
  CHAINTYPE_UNKNOWN,        
  // new chain types
  CHAINTYPE_MACROLIDE,              
  CHAINTYPE_CYCLIC_PSEUDO_PEPTIDE,  
  CHAINTYPE_POLY_PEPTIDE_DN_RN,     
  CHAINTYPE_BRANCHED,               
  CHAINTYPE_OLIGOSACCHARIDE,        
  CHAINTYPE_N_CHAINTYPES    
} ChainType;

ChainType DLLEXPORT_OST_MOL ChainTypeFromString(const StringRef identifier);

ChainType DLLEXPORT_OST_MOL ChainTypeFromString(const String& identifier);

String DLLEXPORT_OST_MOL StringFromChainType(ChainType type);

String DLLEXPORT_OST_MOL EntityTypeFromChainType(ChainType type);

String DLLEXPORT_OST_MOL EntityPolyTypeFromChainType(ChainType type);

String DLLEXPORT_OST_MOL BranchedTypeFromChainType(ChainType type);

}} //ns

#endif