Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)

Public Member Functions
concepts::RCP< const ElementFormula< F, G > > Class Template Reference

#include <elementFormulaRCP.hh>

Inheritance diagram for concepts::RCP< const ElementFormula< F, G > >:
Inheritance graph
[legend]
Collaboration diagram for concepts::RCP< const ElementFormula< F, G > >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

RCP< const ElementFormula< F,
G > > & 
operator= (const RCP< const ElementFormula< F, G > > &x)
template<class H >
RCP< const ElementFormula< F,
G > > & 
operator= (const RCP< H > &x)
 RCP (boost::shared_ptr< const ElementFormula< F, G > > &x)
 conversion constructor from boost::shared_ptr
 RCP (const ElementFormula< F, G > &x)
 Constructor with a given reference, ElementFormula will be cloned.
template<class H , class I >
 RCP (H x, I y)
 Constructor with any two parameters, I is a deleter function.
template<class H >
 RCP (const boost::shared_ptr< H > &x)
 conversion constructor from boost::shared_ptr<H>, where H can be converted into ElementFormula<F,G>
 RCP (const F x)
 Special constructor for a constant.
 RCP (const ElementFormula< F, G > *x)
 Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP.
 RCP ()
 Default constructor, creates an RCP to a NULL-pointer.

Detailed Description

template<class F, typename G>
class concepts::RCP< const ElementFormula< F, G > >

Definition at line 27 of file elementFormulaRCP.hh.


Constructor & Destructor Documentation

template<class F , typename G >
concepts::RCP< const ElementFormula< F, G > >::RCP ( const F  x) [inline, explicit]

Special constructor for a constant.

So, a constant can simply given to functions where a RCP<ElementFormula<F> > is expected.

See also:
testsuite/testFormula.cc

Definition at line 38 of file elementFormulaRCP.hh.

template<class F , typename G >
concepts::RCP< const ElementFormula< F, G > >::RCP ( ) [inline]

Default constructor, creates an RCP to a NULL-pointer.

Definition at line 43 of file elementFormulaRCP.hh.

template<class F , typename G >
concepts::RCP< const ElementFormula< F, G > >::RCP ( const ElementFormula< F, G > *  x) [inline, explicit]

Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP.

It should be only called with pointer to dynamic variables, e.g.

RCP<const ElementFormula<Real> > p(new ConstFormula<Real>(4));

Do NOT use it with pointers to variables in the stack. Do not

ConstFormula<Real> i = 4; 
        RCP<const ElementFormula<Real> > p(&i); // <-- DO NOT -- 

Instead use the constructor for references (below) which makes a clone.

Definition at line 67 of file elementFormulaRCP.hh.

template<class F , typename G >
concepts::RCP< const ElementFormula< F, G > >::RCP ( boost::shared_ptr< const ElementFormula< F, G > > &  x) [inline]

conversion constructor from boost::shared_ptr

Definition at line 71 of file elementFormulaRCP.hh.

template<class F , typename G >
template<class H >
concepts::RCP< const ElementFormula< F, G > >::RCP ( const boost::shared_ptr< H > &  x) [inline]

conversion constructor from boost::shared_ptr<H>, where H can be converted into ElementFormula<F,G>

Definition at line 77 of file elementFormulaRCP.hh.

template<class F , typename G >
template<class H , class I >
concepts::RCP< const ElementFormula< F, G > >::RCP ( x,
y 
) [inline]

Constructor with any two parameters, I is a deleter function.

Definition at line 82 of file elementFormulaRCP.hh.

template<class F , typename G >
concepts::RCP< const ElementFormula< F, G > >::RCP ( const ElementFormula< F, G > &  x) [inline]

Constructor with a given reference, ElementFormula will be cloned.

: this function is slightly inefficient (a copy is created), : try to write code which does NOT depend on this function,

Definition at line 97 of file elementFormulaRCP.hh.


Member Function Documentation

template<class F , typename G >
RCP<const ElementFormula<F,G> >& concepts::RCP< const ElementFormula< F, G > >::operator= ( const RCP< const ElementFormula< F, G > > &  x) [inline]

Definition at line 104 of file elementFormulaRCP.hh.

template<class F , typename G >
template<class H >
RCP<const ElementFormula<F,G> >& concepts::RCP< const ElementFormula< F, G > >::operator= ( const RCP< H > &  x) [inline]

Definition at line 112 of file elementFormulaRCP.hh.


The documentation for this class was generated from the following file:

Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)