stage/include/ost/mol/chain_base.hh
Go to the documentation of this file.00001 //------------------------------------------------------------------------------ 00002 // This file is part of the OpenStructure project <www.openstructure.org> 00003 // 00004 // Copyright (C) 2008-2011 by the OpenStructure authors 00005 // 00006 // This library is free software; you can redistribute it and/or modify it under 00007 // the terms of the GNU Lesser General Public License as published by the Free 00008 // Software Foundation; either version 3.0 of the License, or (at your option) 00009 // any later version. 00010 // This library is distributed in the hope that it will be useful, but WITHOUT 00011 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00012 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 00013 // details. 00014 // 00015 // You should have received a copy of the GNU Lesser General Public License 00016 // along with this library; if not, write to the Free Software Foundation, Inc., 00017 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 00018 //------------------------------------------------------------------------------ 00019 #ifndef OST_CHAIN_BASE_HH 00020 #define OST_CHAIN_BASE_HH 00021 00022 #include <ost/mol/module_config.hh> 00023 #include <ost/mol/impl/chain_impl_fw.hh> 00024 00025 #include <ost/mol/chain_type.hh> 00026 #include <ost/generic_property.hh> 00027 00028 namespace ost { namespace mol { 00029 00039 class DLLEXPORT_OST_MOL ChainBase: 00040 public GenericPropContainer<ChainBase> { 00041 00042 public: // constructors 00043 ChainBase(); 00044 ChainBase(const impl::ChainImplPtr& impl); 00045 public: 00046 00048 00049 00050 00051 00052 00053 00054 00055 operator bool() const { return this->IsValid(); } 00058 bool IsValid() const { return Impl().get()!=0; } 00060 friend class ConstGenericPropContainer<ChainBase>; 00061 String GetName() const; 00062 00066 ChainType GetType() const; 00067 00071 String GetDescription() const; 00072 00073 const impl::ChainImplPtr& Impl() const { 00074 return impl_; 00075 } 00076 00081 bool IsPolymer() const; 00082 00084 bool IsPolysaccharide() const; 00085 00087 bool IsPolypeptide() const; 00088 00090 bool IsPolynucleotide() const; 00091 00092 impl::ChainImplPtr& Impl() { 00093 return impl_; 00094 } 00095 protected: 00096 GenericPropContainerImpl* GpImpl(); 00097 00098 const GenericPropContainerImpl* GpImpl() const; 00099 00100 void CheckValidity() const; 00101 private: 00102 impl::ChainImplPtr impl_; 00103 }; 00104 00105 DLLEXPORT_OST_MOL std::ostream& operator<<(std::ostream& os, 00106 const ChainBase& chain); 00107 }} // ns 00108 00109 #endif // OST_CHAIN_BASE_HH 00110
