AndroMeta/include/AndroMeta/MMLGrid.h

Go to the documentation of this file.

/*
 * Copyright 2009-2012 AndroMeta LLC. All rights reserved.
 *
 * AndroMeta LLC retains all intellectual property and proprietary 
 * rights to this software and related documentation and any modifications 
 * thereto.  Any use, reproduction, disclosure, or distribution of this 
 * software and related documentation without an express license agreement 
 * from AndroMeta LLC is strictly prohibited.
 * 
 */

#ifndef ANDROMETA_MML_GRID_H
#define ANDROMETA_MML_GRID_H

#include <AndroMeta/MMLEntity.h>

namespace Meta{
  
  class MMLGrid : public MMLEntity{
  public:
    
    MMLGrid(const mvec& dimensions, const mvar& locality);
    
    MMLGrid(const mstr& dataPath);
    
    ~MMLGrid();
    
    mnode process(mnode n, uint32_t flags=0);
    
    enum BoundaryRule{
      BoundaryError,
      BoundaryClamp,
      BoundaryWrap
    };
    
    void setBoundaryRule(size_t dimension, BoundaryRule rule);
    
    void setBoundaryRule(size_t dimension, const mstr& rule);
    
    void createAgent(const mvar& agent);
    
    virtual mvar initAgent(mvar& agent);
    
    virtual mvar initCell(mvar& cell);
    
    virtual mvar runAgent(mvar& agent, mvar& cell);
    
    void selectAgents(const mvar& params=undef);
    
    virtual mvar selectAgent(const mvar& params,
                             const mvar& cell,
                             const mvar& agent,
                             const mvar& selectCell,
                             const mvar& selectAgent);
    
    void applyAgents(const mvar& params=undef);
    
    virtual mvar applyAgent(const mvar& params, mvar& cell, mvar& agent);
    
    void selectCells(const mvar& params=undef);
    
    virtual mvar selectCell(const mvar& params,
                            const mvar& cell,
                            const mvar& selectCell);
    
    void applyCells(const mvar& params=undef);
    
    virtual mvar applyCell(const mvar& params, mvar& cell);
    
    void moveTo(const mvec& pos);
    
    void die();
    
    mvar run();
    
    void setRunCycles(size_t cycles);
    
    const mvec& dimensions() const;
    
    const mvar& data() const;
    
  private:
    MMLGrid& operator=(const MMLGrid&);
    MMLGrid(const MMLGrid&);
    
    class MMLGrid_* x_;
  };
  
} // end namespace Meta

#endif // ANDROMETA_MML_GRID_H