Homec4science
Diffusion akantu (master) Browse

rAKA/synchronizer/data_accessor.hh
f14ef1c549b2master

Last Change
Raw File

data_accessor.hh
View Options

/**
* @file data_accessor.hh
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
* @date Wed Jun 15 14:43:23 2011
*
* @brief Interface of accessors for pack_unpack system
*
* @section LICENSE
*
* Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* Akantu 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 of the License, or (at your option) any
* later version.
*
* Akantu 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 Akantu. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef __AKANTU_DATA_ACCESSOR_HH__
#define __AKANTU_DATA_ACCESSOR_HH__
/* -------------------------------------------------------------------------- */
#include "aka_common.hh"
#include "mesh.hh"
#include "communication_buffer.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_AKANTU__
class DataAccessor {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
DataAccessor();
virtual ~DataAccessor();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
/**
* @brief get the number of data to send for a given akantu::Element and a
* given akantu::SynchronizationTag
*/
virtual UInt getNbDataToPack(const Element & element,
SynchronizationTag tag) const = 0;
/**
* @brief get the number of data to send for a given
* akantu::SynchronizationTag
*/
virtual UInt getNbDataToPack(SynchronizationTag tag) const = 0;
/**
* @brief get the number of data to receive for a given akantu::Element and a
* given akantu::SynchronizationTag
*/
virtual UInt getNbDataToUnpack(const Element & element,
SynchronizationTag tag) const = 0;
/**
* @brief get the number of data to receive for a given
* akantu::SynchronizationTag
*/
virtual UInt getNbDataToUnpack(SynchronizationTag tag) const = 0;
/**
* @brief pack the data for a given akantu::Element and a given
* akantu::SynchronizationTag
*/
virtual void packData(CommunicationBuffer & buffer,
const Element & element,
SynchronizationTag tag) const = 0;
/**
* @brief pack the data for a given index and a given
* akantu::SynchronizationTag
*/
virtual void packData(CommunicationBuffer & buffer,const UInt index,
SynchronizationTag tag) const = 0;
/**
* @brief unpack the data for a given akantu::Element and a given
* akantu::SynchronizationTag
*/
virtual void unpackData(CommunicationBuffer & buffer,
const Element & element,
SynchronizationTag tag) const = 0;
/**
* @brief unpack the data for a given index and a given
* akantu::SynchronizationTag
*/
virtual void unpackData(CommunicationBuffer & buffer,
const UInt index,
SynchronizationTag tag) const = 0;
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
private:
};
/* -------------------------------------------------------------------------- */
/* inline functions */
/* -------------------------------------------------------------------------- */
// #include "data_accessor_inline_impl.cc"
// /// standard output stream operator
// inline std::ostream & operator <<(std::ostream & stream, const DataAccessor & _this)
// {
// _this.printself(stream);
// return stream;
// }
__END_AKANTU__
#endif /* __AKANTU_DATA_ACCESSOR_HH__ */
c4science · Help