Function RCPP_API_CLASS

inst/include/Rcpp/S4.h:29–74

* S4 object */

     * S4 object
     */
    RCPP_API_CLASS(S4_Impl) {
    public:
        RCPP_GENERATE_CTOR_ASSIGN(S4_Impl)

        S4_Impl(){} ;

        /**
         * checks that x is an S4 object and wrap it.
         *
         * @param x must be an S4 object
         */
        S4_Impl(SEXP x) {				// #nocov start
            if( ! ::Rf_isS4(x) ) throw not_s4() ;
            Storage::set__(x) ;
        }								// #nocov end

        S4_Impl& operator=( SEXP other ){
            Storage::set__( other ) ;
            return *this ;
        }

        /**
         * Creates an S4 object of the requested class.
         *
         * @param klass name of the target S4 class
         * @throw S4_creation_error if klass does not map to a known S4 class
         */
        S4_Impl( const std::string& klass ){
            Shield<SEXP> x( R_do_new_object(R_do_MAKE_CLASS(klass.c_str())) );
            if (!Rf_inherits(x, klass.c_str()))
                throw S4_creation_error( klass ) ; // #nocov
            Storage::set__(x) ;
        }

        /**
         * Indicates if this object is an instance of the given S4 class
         */
        bool is( const std::string& clazz) const ;

        /**
         * @throw not_s4 if x is not an S4 class
         */
        void update(SEXP x){
            if( ! ::Rf_isS4(x) ) throw not_s4() ;
        }
    } ;

    typedef S4_Impl<PreserveStorage> S4 ;