Reference.h

Go to the documentation of this file.

// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
//
// Reference.h: Rcpp R/C++ interface class library -- S4 objects
//
// Copyright (C) 2010 - 2011 Dirk Eddelbuettel and Romain Francois
//
// This file is part of Rcpp.
//
// Rcpp is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// Rcpp 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.

#ifndef Rcpp_Reference_h
#define Rcpp_Reference_h                     

#include <Rcpp/S4.h>
#include <Rcpp/exceptions.h>

namespace Rcpp{ 

    class Reference : public S4 {
    public:
        Reference() ;
        
        Reference(SEXP x) ; 
        
        Reference(const Reference& other) ;
        Reference(const RObject::SlotProxy& proxy ) ;
        Reference(const RObject::AttributeProxy& proxy ) ;
        
        Reference& operator=( const Reference& other);
        Reference& operator=( SEXP other ) ; 
        
        Reference( const std::string& klass ) ;

        
        // TODO: perhaps I should move this to RObject (do the same as SlotProxy, etc ...)
        class FieldProxy {
        public:
            FieldProxy( const Reference& v, const std::string& name) ;

            FieldProxy& operator=(const FieldProxy& rhs) ;
                
            template <typename T> FieldProxy& operator=(const T& rhs){
                set( wrap(rhs) ) ;
                return *this ;
            }
                
            template <typename T> operator T() const {
                return as<T>(get()) ;
            }
                
        private:
            const Reference& parent; 
            std::string field_name ;
                
            SEXP get() const ;
            void set(SEXP x ) const;
        } ;
        friend class FieldProxy ;   
                
        FieldProxy field( const std::string& name) const  ;
    
    
    private:
        void set( SEXP x) ;        
    } ;

} // namespace Rcpp

#endif