FemModel< T >::Builder Class Reference

Detailed Description

template<typename T>
class drake::multibody::fem::FemModel< T >::Builder

Builder that builds the FemModel.

Each concrete FemModel must define its own builder, subclassing this class, to add new elements to the model.

#include <drake/multibody/fem/fem_model.h>

Public Member Functions
virtual	~Builder ()
void	Build ()
	Adds the FEM elements described by calls to this builder to this associated FemModel.
Does not allow copy, move, or assignment
	Builder (const Builder &)=delete
Builder &	operator= (const Builder &)=delete
	Builder (Builder &&)=delete
Builder &	operator= (Builder &&)=delete

Protected Member Functions
void	ThrowIfBuilt () const
	Throws an exception if Build() has been called on this Builder.
	Builder (FemModel< T > *model)
	Constructs a new builder that builds into the given model.
virtual void	DoBuild ()=0
	Derived builders must provide implementations for this function to add the FEM elements described by calls to the builder to the associated FemModel.

Constructor & Destructor Documentation

Builder() [1/3]

template<typename T>

Builder ( const Builder & )

delete

Builder() [2/3]

template<typename T>

Builder ( Builder && )

delete

~Builder()

template<typename T>

virtual ~Builder ( )

virtual

Builder() [3/3]

template<typename T>

Builder ( FemModel< T > * model )

explicitprotected

Constructs a new builder that builds into the given model.

Precondition

model != nullptr.

Note

The model pointer is persisted and the pointed to FemModel must outlive this *Builder.

Member Function Documentation

Build()

template<typename T>

void Build

(

)

Adds the FEM elements described by calls to this builder to this associated FemModel.

The builder is left in an invalid state after Build() is invoked, and should thus be discarded and not reused again.

DoBuild()

template<typename T>

virtual void DoBuild ( )

protectedpure virtual

Derived builders must provide implementations for this function to add the FEM elements described by calls to the builder to the associated FemModel.

operator=() [1/2]

template<typename T>

Builder & operator= ( Builder && )

delete

operator=() [2/2]

template<typename T>

Builder & operator= ( const Builder & )

delete

ThrowIfBuilt()

template<typename T>

void ThrowIfBuilt ( ) const

protected

Throws an exception if Build() has been called on this Builder.

---

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

• drake/multibody/fem/fem_model.h