epics::pvData::FieldBuilder Class Reference

Interface for in-line creating of introspection interfaces. More...

#include "pvIntrospect.h"

Inheritance diagram for epics::pvData::FieldBuilder:

Collaboration diagram for epics::pvData::FieldBuilder:

Public Member Functions
FieldBuilderPtr	setId (std::string const &id)
FieldBuilderPtr	add (std::string const &name, ScalarType scalarType)
FieldBuilderPtr	addBoundedString (std::string const &name, std::size_t maxLength) PVD_DEPRECATED_52
FieldBuilderPtr	add (std::string const &name, FieldConstPtr const &field)
FieldBuilderPtr	addArray (std::string const &name, ScalarType scalarType)
FieldBuilderPtr	addFixedArray (std::string const &name, ScalarType scalarType, std::size_t size) PVD_DEPRECATED_52
FieldBuilderPtr	addBoundedArray (std::string const &name, ScalarType scalarType, std::size_t bound) PVD_DEPRECATED_52
FieldBuilderPtr	addArray (std::string const &name, FieldConstPtr const &element)
StructureConstPtr	createStructure ()
UnionConstPtr	createUnion ()
FieldBuilderPtr	addNestedStructure (std::string const &name)
FieldBuilderPtr	addNestedUnion (std::string const &name)
FieldBuilderPtr	addNestedStructureArray (std::string const &name)
FieldBuilderPtr	addNestedUnionArray (std::string const &name)
FieldBuilderPtr	endNested ()

Static Public Member Functions
static FieldBuilderPtr	begin ()
static FieldBuilderPtr	begin (StructureConstPtr S)
	Create a new instance of in-line Field builder pre-initialized with and existing Structure. More...

Friends
class	FieldCreate

Detailed Description

Interface for in-line creating of introspection interfaces.

One instance can be used to create multiple Field instances. An instance of this object must not be used concurrently (an object has a state).

Author

mse

Definition at line 1072 of file pvIntrospect.h.

Member Function Documentation

FieldBuilderPtr epics::pvData::FieldBuilder::add	(	std::string const &	name,
		ScalarType	scalarType
	)

Add a Scalar.

Parameters

name	name of the array.
scalarType	type of a scalar to add.

Returns

this instance of a FieldBuilder.

FieldBuilderPtr epics::pvData::FieldBuilder::add	(	std::string const &	name,
		FieldConstPtr const &	field
	)

Add a Field (e.g. Structure, Union).

Parameters

name	name of the array.
field	a field to add.

Returns

this instance of a FieldBuilder.

FieldBuilderPtr epics::pvData::FieldBuilder::addArray	(	std::string const &	name,
		ScalarType	scalarType
	)

Add variable size array of Scalar elements.

Parameters

name	name of the array.
scalarType	type of a scalar element.

Returns

this instance of a FieldBuilder.

FieldBuilderPtr epics::pvData::FieldBuilder::addArray	(	std::string const &	name,
		FieldConstPtr const &	element
	)

Add array of Field elements.

Parameters

name	name of the array.
element	a type of an array element.

Returns

this instance of a FieldBuilder.

FieldBuilderPtr epics::pvData::FieldBuilder::addBoundedArray	(	std::string const &	name,
		ScalarType	scalarType,
		std::size_t	bound
	)

Add bounded-size array of Scalar elements.

Parameters

name	name of the array.
scalarType	type of a scalar element.
bound	Array maximum capacity (size).

Returns

this instance of a FieldBuilder.

Definition at line 1039 of file FieldCreateFactory.cpp.

{
    return add(name, fieldCreate->createBoundedScalarArray(scalarType, size));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addBoundedString	(	std::string const &	name,
		std::size_t	maxLength
	)

Add a BoundedString.

Parameters

name	name of the array.
maxLength	a string maximum length.

Returns

this instance of a FieldBuilder.

Definition at line 1013 of file FieldCreateFactory.cpp.

{
    return add(name, fieldCreate->createBoundedString(maxLength));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addFixedArray	(	std::string const &	name,
		ScalarType	scalarType,
		std::size_t	size
	)

Add fixed-size array of Scalar elements.

Parameters

name	name of the array.
scalarType	type of a scalar element.
size	Array fixed size.

Returns

this instance of a FieldBuilder.

Definition at line 1034 of file FieldCreateFactory.cpp.

{
    return add(name, fieldCreate->createFixedScalarArray(scalarType, size));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addNestedStructure

(

std::string const &

name

)

Add new nested Structure. endNested() method must be called to complete creation of the nested Structure.

Parameters

name	nested structure name.

Returns

a new instance of a FieldBuilder is returned.

See also

endNested()

Definition at line 1135 of file FieldCreateFactory.cpp.

{
    const Field *cur = findField(name, structure);
    if(cur) {
        return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name,
                                                static_cast<const Structure*>(cur)));
    }
    return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name, structure, false));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addNestedStructureArray

(

std::string const &

name

)

Add new nested Structure[]. endNested() method must be called to complete creation of the nested Structure.

Parameters

name	nested structure name.

Returns

a new instance of a FieldBuilder is returned.

See also

endNested()

Definition at line 1157 of file FieldCreateFactory.cpp.

{
    const Field *cur = findField(name, structureArray);
    if(cur) {
        return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name,
                                                static_cast<const StructureArray*>(cur)));
    }
    return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name, structure, true));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addNestedUnion

(

std::string const &

name

)

Add new nested Union. endNested() method must be called to complete creation of the nested Union.

Parameters

name	nested union name.

Returns

a new instance of a FieldBuilder is returned.

See also

endNested()

Definition at line 1146 of file FieldCreateFactory.cpp.

{
    const Field *cur = findField(name, union_);
    if(cur) {
        return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name,
                                                static_cast<const Union*>(cur)));
    }
    return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name, union_, false));
}

FieldBuilderPtr epics::pvData::FieldBuilder::addNestedUnionArray

(

std::string const &

name

)

Add new nested Union[]. endNested() method must be called to complete creation of the nested Union.

Parameters

name	nested union name.

Returns

a new instance of a FieldBuilder is returned.

See also

endNested()

Definition at line 1167 of file FieldCreateFactory.cpp.

{
    const Field *cur = findField(name, unionArray);
    if(cur) {
        return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name,
                                                static_cast<const UnionArray*>(cur)));
    }
    return FieldBuilderPtr(new FieldBuilder(shared_from_this(), name, union_, true));
}

FieldBuilderPtr epics::pvData::FieldBuilder::begin ( )

static

Create a new instance of in-line Field builder.

Version

Added after 7.0.0

Definition at line 988 of file FieldCreateFactory.cpp.

{
    FieldBuilderPtr ret(new FieldBuilder);
    return ret;
}

FieldBuilderPtr epics::pvData::FieldBuilder::begin ( StructureConstPtr  S )

static

Create a new instance of in-line Field builder pre-initialized with and existing Structure.

Definition at line 994 of file FieldCreateFactory.cpp.

{
    FieldBuilderPtr ret(new FieldBuilder(S.get()));
    return ret;
}

StructureConstPtr epics::pvData::FieldBuilder::createStructure

(

)

Create a Structure. This resets this instance state and allows new Field instance to be created.

Returns

a new instance of a Structure.

Definition at line 1099 of file FieldCreateFactory.cpp.

{
    if (parentBuilder.get())
        THROW_EXCEPTION2(std::runtime_error, "createStructure() called in nested FieldBuilder");

    StructureConstPtr field(static_pointer_cast<const Structure>(createFieldInternal(structure)));
    reset();
    return field;
}

UnionConstPtr epics::pvData::FieldBuilder::createUnion

(

)

Create an Union. This resets this instance state and allows new Field instance to be created.

Returns

a new instance of an Union.

Definition at line 1109 of file FieldCreateFactory.cpp.

{
    if (parentBuilder.get())
        THROW_EXCEPTION2(std::runtime_error, "createUnion() called in nested FieldBuilder");

    UnionConstPtr field(static_pointer_cast<const Union>(createFieldInternal(union_)));
    reset();
    return field;
}

FieldBuilderPtr epics::pvData::FieldBuilder::endNested

(

)

Complete the creation of a nested object.

See also

addNestedStructure(std::string const & name)

addNestedUnion(std::string const & name)

Returns

a previous (parent) FieldBuilder.

Definition at line 1177 of file FieldCreateFactory.cpp.

{
    if (!parentBuilder)
        THROW_EXCEPTION2(std::runtime_error, "FieldBuilder::endNested() can only be called to create nested fields");

    FieldConstPtr nestedField = createFieldInternal(nestedClassToBuild);

    if(createNested) {
        if (nestedArray)
            parentBuilder->addArray(nestedName, nestedField);
        else
            parentBuilder->add(nestedName, nestedField);
        return parentBuilder;
    } else {
        for(size_t i=0, N = parentBuilder->fieldNames.size(); i<N; i++)
        {
            if(nestedName!=parentBuilder->fieldNames[i])
                continue;

            if(nestedArray) {
                if(nestedClassToBuild==structure)
                    parentBuilder->fields[i] = fieldCreate->createStructureArray(std::tr1::static_pointer_cast<const Structure>(nestedField));
                else if(nestedClassToBuild==union_)
                    parentBuilder->fields[i] = fieldCreate->createUnionArray(std::tr1::static_pointer_cast<const Union>(nestedField));
                else
                    throw std::logic_error("bad nested class");
            } else {
                parentBuilder->fields[i] = nestedField;
            }
            return parentBuilder;
        }
        // this only reached if bug in ctor
        THROW_EXCEPTION2(std::logic_error, "no nested field field?");
    }
}

FieldBuilderPtr epics::pvData::FieldBuilder::setId

(

std::string const &

id

)

Set ID of an object to be created.

Parameters

id	id to be set.

Returns

this instance of a FieldBuilder.

Definition at line 1001 of file FieldCreateFactory.cpp.

{
    this->id = id;
    idSet = true;
    return shared_from_this();
}

Friends And Related Function Documentation

friend class FieldCreate

friend

Definition at line 1225 of file pvIntrospect.h.

---

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

• modules/pvData/src/pv/pvIntrospect.h
• modules/pvData/src/factory/FieldCreateFactory.cpp