epics::nt::Result Struct Reference

Validation methods for NT types. More...

#include "validator.h"

Collaboration diagram for epics::nt::Result:

Classes
struct	Error

Public Types
enum	result_t { Pass, Fail }

Public Member Functions
	Result (const epics::pvData::FieldConstPtr &field, const std::string &path=std::string())
	Result ()
Result &	operator|= (const Result &other)
bool	valid (void) const
template<typename T >
Result &	is (void)
template<typename T >
Result &	is (const std::string &id)
template<Result &(*)(Result &) fn>
Result &	has (const std::string &name)
template<Result &(*)(Result &) fn>
Result &	maybeHas (const std::string &name)
template<Result &(*)(Result &) fn, typename T >
Result &	has (const std::string &name)
template<Result &(*)(Result &) fn, typename T >
Result &	maybeHas (const std::string &name)
template<typename T >
Result &	has (const std::string &name)
template<typename T >
Result &	maybeHas (const std::string &name)
std::ostream &	dump (std::ostream &os) const

Public Attributes
epics::pvData::FieldConstPtr	field
std::string	path
std::vector< Error >	errors
enum epics::nt::Result::result_t	result

Detailed Description

Validation methods for NT types.

Author

bsm

Definition at line 23 of file validator.h.

Member Enumeration Documentation

enum epics::nt::Result::result_t

Enumerator
Pass
Fail

Definition at line 56 of file validator.h.

                  {
        Pass,
        Fail,
    } result;

Constructor & Destructor Documentation

epics::nt::Result::Result ( const epics::pvData::FieldConstPtr &  field, const std::string &  path = std::string()  )

inline

Definition at line 61 of file validator.h.

    : field(field), path(path), errors(), result(Pass) {}

epics::nt::Result::Result ( )

inline

Definition at line 64 of file validator.h.

{}

Member Function Documentation

std::ostream& epics::nt::Result::dump ( std::ostream &  os ) const

inline

Definition at line 220 of file validator.h.

                                           {
        os << "Result(valid=" << (result == Pass) << ", errors=[ ";

        std::vector<Error>::const_iterator it;
        for (it = errors.begin(); it != errors.end(); ++it) {
            (*it).dump(os);
            os << " ";
        }
        os << "])";
        return os;
    }

template<Result &(*)(Result &) fn>

Result& epics::nt::Result::has ( const std::string &  name )

inline

Test that this Result's field has a subfield with name 'name' and apply the function 'fn' to the subfield.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray. Appends an Error::Type::MissingField if the subfield is not present.

Returns

itself

Definition at line 132 of file validator.h.

                                       {
        return has<epics::pvData::Field>(name, false, fn);
    }

template<Result &(*)(Result &) fn, typename T >

Result& epics::nt::Result::has ( const std::string &  name )

inline

Test that this Result's field has a subfield with name 'name', apply the function 'fn' to the subfield and test that the subfield is of type 'T'.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray. Appends an Error::Type::IncorrectType if the subfield is not of type 'T'. Appends an Error::Type::MissingField if the subfield is not present.

Returns

itself

Definition at line 165 of file validator.h.

                                       {
        return has<T>(name, false, fn);
    }

template<typename T >

Result& epics::nt::Result::has ( const std::string &  name )

inline

Test that this Result's field has a subfield with name 'name' and test that the subfield is of type 'T'.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray. Appends an Error::Type::IncorrectType if the subfield is not of type 'T'. Appends an Error::Type::MissingField if the subfield is not present.

Returns

itself

Definition at line 200 of file validator.h.

                                       {
        return has<T>(name, false, NULL);
    }

template<typename T >

Result& epics::nt::Result::is ( void  )

inline

Test that this Result's field is of a particular type 'T'.

Appends an Error::Type::IncorrectType if the field is not of type 'T'.

Returns

itself

Definition at line 89 of file validator.h.

                     {
        if (!dynamic_cast<T const *>(field.get())) {
            result = Fail;
            errors.push_back(Error(path, Error::IncorrectType));
        }
        return *this;
    }

template<typename T >

Result& epics::nt::Result::is ( const std::string &  id )

inline

Test that this Result's field is of a particular type 'T' and has an ID equal to 'id'.

Appends an Error::Type::IncorrectType if the field is not of type 'T'. Appends an Error::Type::IncorrectId if the field does not have an ID equal to 'id'.

Returns

itself

Definition at line 108 of file validator.h.

                                    {
        T const *s = dynamic_cast<T const *>(field.get());
        if (!s) {
            result = Fail;
            errors.push_back(Error(path, Error::IncorrectType));
        } else if (s->getID() != id) {
            result = Fail;
            errors.push_back(Error(path, Error::IncorrectId));
        }
        return *this;
    }

template<Result &(*)(Result &) fn>

Result& epics::nt::Result::maybeHas ( const std::string &  name )

inline

Test that this Result's field has an optional subfield with name 'name' and, if it has, apply the function 'fn' to the subfield.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray.

Returns

itself

Definition at line 146 of file validator.h.

                                            {
        return has<epics::pvData::Field>(name, true, fn);
    }

template<Result &(*)(Result &) fn, typename T >

Result& epics::nt::Result::maybeHas ( const std::string &  name )

inline

Test that this Result's field has an optional subfield with name 'name' and, if it has, apply the function 'fn' to the subfield and test that the subfield is of type 'T'.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray. Appends an Error::Type::IncorrectType if the subfield exists and is not of type 'T'.

Returns

itself

Definition at line 182 of file validator.h.

                                            {
        return has<T>(name, true, fn);
    }

template<typename T >

Result& epics::nt::Result::maybeHas ( const std::string &  name )

inline

Test that this Result's field has an optional subfield with name 'name' and, if it has, test that the subfield is of type 'T'.

Appends an Error::Type::IncorrectType if the field is not one of Structure, StructureArray, Union, UnionArray. Appends an Error::Type::IncorrectType if the subfield exists and is not of type 'T'.

Returns

itself

Definition at line 216 of file validator.h.

                                            {
        return has<T>(name, true, NULL);
    }

Result& epics::nt::Result::operator|= ( const Result &  other )

inline

Definition at line 66 of file validator.h.

                                            {
        result = std::max(result, other.result);
        errors.insert(errors.end(), other.errors.begin(), other.errors.end());
        return *this;
    }

bool epics::nt::Result::valid ( void  ) const

inline

Returns whether this Result is valid.

Returns

true if all tests passed, false otherwise.

Definition at line 77 of file validator.h.

                                  {
        return result == Pass;
    }

Member Data Documentation

std::vector<Error> epics::nt::Result::errors

Definition at line 54 of file validator.h.

epics::pvData::FieldConstPtr epics::nt::Result::field

Definition at line 52 of file validator.h.

std::string epics::nt::Result::path

Definition at line 53 of file validator.h.

enum epics::nt::Result::result_t epics::nt::Result::result

---

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

• modules/normativeTypes/src/validator.h