container_map.h

//C Copyright (C) 2000-2006 Kevin Cowtan and University of York
//L
//L  This library is free software and is distributed under the terms
//L  and conditions of version 2.1 of the GNU Lesser General Public
//L  Licence (LGPL) with the following additional clause:
//L
//L     `You may also combine or link a "work that uses the Library" to
//L     produce a work containing portions of the Library, and distribute
//L     that work under terms of your choice, provided that you give
//L     prominent notice with each copy of the work that the specified
//L     version of the Library is used in it, and that you include or
//L     provide public access to the complete corresponding
//L     machine-readable source code for the Library including whatever
//L     changes were used in the work. (i.e. If you make changes to the
//L     Library you must distribute those, but you do not need to
//L     distribute source or object code to those portions of the work
//L     not covered by this licence.)'
//L
//L  Note that this clause grants an additional right and does not impose
//L  any additional restriction, and so does not affect compatibility
//L  with the GNU General Public Licence (GPL). If you wish to negotiate
//L  other terms, please contact the maintainer.
//L
//L  You can redistribute it and/or modify the library under the terms of
//L  the GNU Lesser General Public License as published by the Free Software
//L  Foundation; either version 2.1 of the License, or (at your option) any
//L  later version.
//L
//L  This library is distributed in the hope that it will be useful, but
//L  WITHOUT ANY WARRANTY; without even the implied warranty of
//L  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//L  Lesser General Public License for more details.
//L
//L  You should have received a copy of the CCP4 licence and/or GNU
//L  Lesser General Public License along with this library; if not, write
//L  to the CCP4 Secretary, Daresbury Laboratory, Warrington WA4 4AD, UK.
//L  The GNU Lesser General Public can also be obtained by writing to the
//L  Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
//L  MA 02111-1307 USA


#ifndef CLIPPER_CONTAINER_MAP
#define CLIPPER_CONTAINER_MAP


#include "container_types.h"
#include "nxmap_operator.h"


namespace clipper
{


  template<class T> class CXmap : public Container, public Xmap<T>
  {
  public:
    CXmap() {}
    CXmap( Container& parent, const String name = "" );
    void init( const Spacegroup& spacegroup, const Cell& cell, const Grid_sampling& grid_sampling );
    void update();
  };



  template<class T> class CNXmap : public Container, public NXmap<T>
  {
  public:
    CNXmap() {}
    CNXmap( Container& parent, const String name = "" ) :
      Container( parent, name ) {}
  };



  template<class T> class CNXmap_operator : public Container, public NXmap_operator<T>
  {
  public:
    CNXmap_operator() {}
    CNXmap_operator( Container& parent, const String name = "" );
    CNXmap_operator( Container& parent, const String name, const NXmap<T>& nxmap, const RTop_orth& nxop = RTop_orth(RTop<>::null()) );
    void init( const Cell& cell, const Grid_sampling& grid, const NXmap<T>& nxmap, const RTop_orth& nxop );
    void update();
  private:
    const NXmap<T>* nxmap_;  
    RTop_orth nxop_;   
  };


  // template implementations


  template<class T> CXmap<T>::CXmap( Container& parent, const String name ) : Container( parent, name )
  {
    init( NullSpacegroup, NullCell, NullGrid_sampling );
  }


  template<class T> void CXmap<T>::init( const Spacegroup& spacegroup, const Cell& cell, const Grid_sampling& grid_sampling )
  {
    // use supplied values by default
    const Spacegroup* sp = &spacegroup;  // use pointers so we can reassign
    const Cell* cp = &cell;
    const Grid_sampling* gp = &grid_sampling;
    // otherwise get them from the tree
    if ( sp->is_null() ) sp = parent_of_type_ptr<const Spacegroup>();
    if ( cp->is_null() ) cp = parent_of_type_ptr<const Cell>();
    if ( gp->is_null() ) gp = parent_of_type_ptr<const Grid_sampling>();
    // initialise
    if ( sp != NULL && cp != NULL && gp != NULL )
      if ( !sp->is_null() && !cp->is_null() && !gp->is_null() )
        Xmap<T>::init( *sp, *cp, *gp );
    Container::update();
  }


  template<class T> void CXmap<T>::update()
  {
    if ( Xmap_base::is_null() )
      init( NullSpacegroup, NullCell, NullGrid_sampling );
    else
      Container::update();
  }


  template<class T> CNXmap_operator<T>::CNXmap_operator( Container& parent, const String name ) : Container( parent, name ), nxmap_( NULL ), nxop_( RTop_orth::null() ) {}


  template<class T> CNXmap_operator<T>::CNXmap_operator( Container& parent, const String name, const NXmap<T>& nxmap, const RTop_orth& nxop ) : Container( parent, name ), nxmap_( &nxmap ), nxop_( nxop )
  {
    init( NullCell, NullGrid_sampling, NXmap<T>(), RTop_orth::null() );
  }


  template<class T> void CNXmap_operator<T>::init( const Cell& cell, const Grid_sampling& grid_sampling, const NXmap<T>& nxmap, const RTop_orth& nxop )
  {
    // use supplied values by default
    const Cell* cp = &cell;
    const Grid_sampling* gp = &grid_sampling;
    // otherwise get them from the tree
    if ( cp->is_null() ) cp = parent_of_type_ptr<const Cell>();
    if ( gp->is_null() ) gp = parent_of_type_ptr<const Grid_sampling>();
    if ( !nxmap.is_null() ) nxmap_ = &nxmap;
    if ( !nxop.is_null()  ) nxop_ = nxop;
    // initialise
    if ( cp != NULL && gp != NULL & nxmap_ != NULL )
      if ( !cp->is_null() && !gp->is_null() && !nxmap_->is_null() )
        NXmap_operator<T>::init( *cp, *gp, *nxmap_, nxop_ );
    Container::update();
  }


  template<class T> void CNXmap_operator<T>::update()
  {
    if ( NX_operator::is_null() )
      init( NullCell, NullGrid_sampling, NXmap<T>(), RTop_orth::null() );
    else
      Container::update();
  }


} // namespace clipper

#endif