epics::pvData::ValueBuilder Class Reference

#include "valueBuilder.h"

Classes
struct	child
struct	child_scalar
struct	child_scalar_array
struct	child_scalar_base
struct	child_struct

Public Member Functions
	ValueBuilder (const std::string &id=std::string())
	empty structure More...
	ValueBuilder (const PVStructure &)
	Clone existing definition and value. More...
	~ValueBuilder ()
template<ScalarType ENUM>
FORCE_INLINE ValueBuilder &	add (const std::string &name, typename meta::arg_type< typename ScalarTypeTraits< ENUM >::type >::type V)
	Add a scalar field with a given name and initial value. More...
template<class T >
FORCE_INLINE ValueBuilder &	add (const std::string &name, const shared_vector< const T > &V)
	Add a scalar array field. More...
FORCE_INLINE ValueBuilder &	add (const std::string &name, const PVStructure &V)
ValueBuilder &	addNested (const std::string &name, Type type=structure, const std::string &id=std::string())
	Start a sub-structure. More...
ValueBuilder &	endNested ()
	End a sub-structure. More...
std::tr1::shared_ptr< PVStructure >	buildPVStructure () const

Friends
struct	child
struct	child_struct
struct	child_scalar_base
template<typename T >
struct	child_scalar
struct	child_scalar_array

Detailed Description

Incrementally define and initialize a PVStructure

Equivalent to FieldBuilder with the added ability to assign initial values.

epics::pvData::PVStructurePtr val(epics::pvData::ValueBuilder()
                                  .add<pvInt>("intfld", 42)
                                  .addNested("sub")
                                   .add<pvString>("strfld", "testing")
                                  .endNested()
                                  .buildPVStructure());

Definition at line 31 of file valueBuilder.h.

Constructor & Destructor Documentation

epics::pvData::ValueBuilder::ValueBuilder ( const std::string &  id = std::string() )

explicit

empty structure

Definition at line 104 of file valueBuilder.cpp.

:parent(0),id(id) {}

epics::pvData::ValueBuilder::ValueBuilder ( const PVStructure &  clone )

explicit

Clone existing definition and value.

Definition at line 147 of file valueBuilder.cpp.

                                                   :parent(0)
{
    StructureConstPtr ctype(clone.getStructure());
    id = ctype->getID();
    child_struct::fillStruct(*this, clone);
}

epics::pvData::ValueBuilder::~ValueBuilder

(

)

Definition at line 160 of file valueBuilder.cpp.

{
    for(children_t::const_iterator it=children.begin(), end=children.end(); it!=end; ++it)
        delete it->second;
    children.clear();
}

Member Function Documentation

template<ScalarType ENUM>

FORCE_INLINE ValueBuilder& epics::pvData::ValueBuilder::add ( const std::string &  name, typename meta::arg_type< typename ScalarTypeTraits< ENUM >::type >::type  V  )

inline

Add a scalar field with a given name and initial value.

Definition at line 42 of file valueBuilder.h.

    {
        _add(name, ENUM, &V);
        return *this;
    }

template<class T >

FORCE_INLINE ValueBuilder& epics::pvData::ValueBuilder::add ( const std::string &  name, const shared_vector< const T > &  V  )

inline

Add a scalar array field.

Definition at line 50 of file valueBuilder.h.

    {
        _add(name, V);
        return *this;
    }

FORCE_INLINE ValueBuilder& epics::pvData::ValueBuilder::add ( const std::string &  name, const PVStructure &  V  )

inline

Definition at line 56 of file valueBuilder.h.

                                                                                {
        _add(name, V);
        return *this;
    }

ValueBuilder & epics::pvData::ValueBuilder::addNested	(	const std::string &	name,
		Type	type = structure,
		const std::string &	id = std::string()
	)

Start a sub-structure.

Definition at line 225 of file valueBuilder.cpp.

{
    if(type!=structure)
        THROW_EXCEPTION2(std::invalid_argument, "addNested() only supports structure");
    child_struct *sub;
    children_t::const_iterator it(children.find(name));
    if(it==children.end()) {
        epics::auto_ptr<child_struct> store(new child_struct(this, id));
        sub = store.get();
        children[name] = store.get();
        store.release();
    } else if(it->second->type==structure) {
        sub = static_cast<child_struct*>(it->second);
    } else {
        std::ostringstream msg;
        msg<<"Can't replace non-struct field '"<<name<<"' with struct";
        THROW_EXCEPTION2(std::invalid_argument, msg.str());
    }
    sub->builder.id = id;
    return sub->builder;
}

PVStructure::shared_pointer epics::pvData::ValueBuilder::buildPVStructure

(

)

const

Complete building structure

Note

ValueBuilder may be re-used after calling buildPVStructure()

Definition at line 274 of file valueBuilder.cpp.

{
    if(parent)
        THROW_EXCEPTION2(std::logic_error, "Only top level structure may be built.  Missing endNested() ?");

    StructureConstPtr type;
    {
        FieldBuilderPtr tbuild(getFieldCreate()->createFieldBuilder());

        child_struct::buildStruct(*this, tbuild);

        type = tbuild->createStructure();
    }

    PVStructure::shared_pointer root(type->build());

    child_struct::storeStruct(*this, root);

    return root;
}

ValueBuilder & epics::pvData::ValueBuilder::endNested

(

)

End a sub-structure.

Definition at line 247 of file valueBuilder.cpp.

{
    if(!parent) {
        THROW_EXCEPTION2(std::logic_error, "Can't end top of structure");
    }
    return *parent;
}

Friends And Related Function Documentation

friend struct child

friend

Definition at line 80 of file valueBuilder.h.

template<typename T >

friend struct child_scalar

friend

Definition at line 86 of file valueBuilder.h.

friend struct child_scalar_array

friend

Definition at line 88 of file valueBuilder.h.

friend struct child_scalar_base

friend

Definition at line 84 of file valueBuilder.h.

friend struct child_struct

friend

Definition at line 82 of file valueBuilder.h.

---

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

• modules/pvData/src/pv/valueBuilder.h
• modules/pvData/src/pv/valueBuilder.cpp