Teuchos::ObjectBuilder< ObjectType > Class Template Reference

#include <Teuchos_ObjectBuilder.hpp>

Inheritance diagram for Teuchos::ObjectBuilder< ObjectType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ObjectBuilder ()
 
 ~ObjectBuilder ()
 
void setObjectName (const std::string &objectName)
 Set the name of the object this will be a builder for, e.g. "Object".
void setObjectTypeName (const std::string &objectTypeName)
 Set the name of the parameterlist selector, e.g. "Object Type".
void setObjectFactory (const RCP< const AbstractFactory< ObjectType > > &objectFactory, const std::string &objectFactoryName)
 Set a new Object factory object.
std::string getObjectName () const
 Get the name of the Object that will be created on the next call to this->create().
void setDefaultObject (const std::string &defaultObject_name)
 Set the name of the desired object to be created when the parameter list does not specify which object you want and when create is called without arguments.
RCP< ObjectType > create (const std::string &objectName="") const
 

Private Types

typedef RCP< const
AbstractFactory< ObjectType > > 
object_fcty_t

Private Member Functions

void initializeDefaults_ ()

Private Attributes

RCP< ParameterListparamList_
RCP< const ParameterListvalidParamList_
RCP< const
StringToIntegralParameterEntryValidator
< int > > 
objectValidator_
std::string object_name_
std::string objectType_name_
Array< std::string > validObjectNames_
Array< object_fcty_tobjectArray_
std::string defaultObject_name_

Overridden from ParameterListAcceptor



void setParameterList (const RCP< ParameterList > &paramList)
 
RCP< ParameterListgetNonconstParameterList ()
 
RCP< ParameterListunsetParameterList ()
 
RCP< const ParameterListgetParameterList () const
 
RCP< const ParameterListgetValidParameters () const
 

Detailed Description

template<class ObjectType>
class Teuchos::ObjectBuilder< ObjectType >

Definition at line 57 of file Teuchos_ObjectBuilder.hpp.


Member Typedef Documentation

template<class ObjectType >
typedef RCP<const AbstractFactory<ObjectType > > Teuchos::ObjectBuilder< ObjectType >::object_fcty_t [private]

Definition at line 124 of file Teuchos_ObjectBuilder.hpp.


Constructor & Destructor Documentation

template<class ObjectType >
Teuchos::ObjectBuilder< ObjectType >::ObjectBuilder (  )  [inline]

Definition at line 171 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
Teuchos::ObjectBuilder< ObjectType >::~ObjectBuilder (  )  [inline]

Definition at line 178 of file Teuchos_ObjectBuilder.hpp.


Member Function Documentation

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::setObjectName ( const std::string &  objectName  )  [inline]

Set the name of the object this will be a builder for, e.g. "Object".

Definition at line 363 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::setObjectTypeName ( const std::string &  objectTypeName  )  [inline]

Set the name of the parameterlist selector, e.g. "Object Type".

Definition at line 374 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::setObjectFactory ( const RCP< const AbstractFactory< ObjectType > > &  objectFactory,
const std::string &  objectFactoryName 
) [inline]

Set a new Object factory object.

Definition at line 190 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
std::string Teuchos::ObjectBuilder< ObjectType >::getObjectName (  )  const [inline]

Get the name of the Object that will be created on the next call to this->create().

Definition at line 208 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::setDefaultObject ( const std::string &  defaultObject_name  )  [inline]

Set the name of the desired object to be created when the parameter list does not specify which object you want and when create is called without arguments.

Definition at line 302 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP< ObjectType > Teuchos::ObjectBuilder< ObjectType >::create ( const std::string &  objectName = ""  )  const [inline]

Definition at line 319 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::setParameterList ( const RCP< ParameterList > &  paramList  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 226 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP< ParameterList > Teuchos::ObjectBuilder< ObjectType >::getNonconstParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 239 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP< ParameterList > Teuchos::ObjectBuilder< ObjectType >::unsetParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 247 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP< const ParameterList > Teuchos::ObjectBuilder< ObjectType >::getParameterList (  )  const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 262 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP< const ParameterList > Teuchos::ObjectBuilder< ObjectType >::getValidParameters (  )  const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 270 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
void Teuchos::ObjectBuilder< ObjectType >::initializeDefaults_ (  )  [inline, private]

Definition at line 385 of file Teuchos_ObjectBuilder.hpp.


Member Data Documentation

template<class ObjectType >
RCP<ParameterList> Teuchos::ObjectBuilder< ObjectType >::paramList_ [private]

Definition at line 129 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP<const ParameterList> Teuchos::ObjectBuilder< ObjectType >::validParamList_ [mutable, private]

Definition at line 130 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP<const StringToIntegralParameterEntryValidator<int> > Teuchos::ObjectBuilder< ObjectType >::objectValidator_ [mutable, private]

Definition at line 131 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
std::string Teuchos::ObjectBuilder< ObjectType >::object_name_ [private]

Definition at line 133 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
std::string Teuchos::ObjectBuilder< ObjectType >::objectType_name_ [private]

Definition at line 134 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
Array<std::string> Teuchos::ObjectBuilder< ObjectType >::validObjectNames_ [private]

Definition at line 136 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
Array<object_fcty_t> Teuchos::ObjectBuilder< ObjectType >::objectArray_ [private]

Definition at line 137 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
std::string Teuchos::ObjectBuilder< ObjectType >::defaultObject_name_ [private]

Definition at line 138 of file Teuchos_ObjectBuilder.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Tue Oct 20 10:14:04 2009 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.1