This class implements introspection object for a structure. More...

#include "pvIntrospect.h"

Inheritance diagram for epics::pvData::Structure:

Collaboration diagram for epics::pvData::Structure:

Public Types
typedef Structure &	reference

typedef const Structure &	const_reference

Public Types inherited from epics::pvData::Field
enum	{ isField =1 }

Public Member Functions
	POINTER_DEFINITIONS (Structure)

virtual	~Structure ()

std::size_t	getNumberFields () const

FieldConstPtr	getField (std::string const &fieldName) const

template<typename FT >
std::tr1::shared_ptr< const FT >	getField (std::string const &fieldName) const

FieldConstPtr	getFieldT (std::string const &fieldName) const

template<typename FT >
std::tr1::shared_ptr< const FT >	getFieldT (std::string const &fieldName) const

const FieldConstPtr &	getField (std::size_t index) const

template<typename FT >
std::tr1::shared_ptr< const FT >	getField (std::size_t index) const

FieldConstPtr	getFieldT (std::size_t index) const

template<typename FT >
std::tr1::shared_ptr< const FT >	getFieldT (std::size_t index) const

std::size_t	getFieldIndex (std::string const &fieldName) const

FieldConstPtrArray const &	getFields () const

StringArray const &	getFieldNames () const

const std::string &	getFieldName (std::size_t fieldIndex) const

virtual std::string	getID () const OVERRIDE FINAL

virtual std::ostream &	dump (std::ostream &o) const OVERRIDE FINAL

virtual void	serialize (ByteBuffer buffer, SerializableControl control) const OVERRIDE FINAL

virtual void	deserialize (ByteBuffer buffer, DeserializableControl control) OVERRIDE FINAL

std::tr1::shared_ptr< PVStructure >	build () const

Public Member Functions inherited from epics::pvData::Field
	POINTER_DEFINITIONS (Field)

virtual	~Field ()

Type	getType () const

std::tr1::shared_ptr< PVField >	build () const

Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()

Static Public Member Functions
static const std::string &	defaultId ()

Static Public Attributes
static const std::string	DEFAULT_ID = Structure::defaultId()

Static Public Attributes inherited from epics::pvData::Field
static size_t	num_instances

Protected Member Functions
	Structure (StringArray const &fieldNames, FieldConstPtrArray const &fields, std::string const &id=defaultId())

Protected Member Functions inherited from epics::pvData::Field
	Field (Type type)

void	cacheCleanup ()

Friends
class	FieldCreate

class	Union

Detailed Description

This class implements introspection object for a structure.

Definition at line 697 of file pvIntrospect.h.

Member Typedef Documentation

typedef const Structure& epics::pvData::Structure::const_reference

Definition at line 714 of file pvIntrospect.h.

typedef Structure& epics::pvData::Structure::reference

Definition at line 713 of file pvIntrospect.h.

Constructor & Destructor Documentation

epics::pvData::Structure::~Structure ( )

virtual

Definition at line 550 of file FieldCreateFactory.cpp.

 {
     cacheCleanup();
 }

epics::pvData::Structure::Structure	(	StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields,
		std::string const &	id = `defaultId()`
	)

protected

Definition at line 514 of file FieldCreateFactory.cpp.

 : Field(structure),
       fieldNames(fieldNames),
       fields(infields),
       id(inid)
 {
     if(inid.empty()) {
         THROW_EXCEPTION2(std::invalid_argument, "Can't construct Structure, id is empty string");
     }
     if(fieldNames.size()!=fields.size()) {
         THROW_EXCEPTION2(std::invalid_argument, "Can't construct Structure, fieldNames.size()!=fields.size()");
     }
     size_t number = fields.size();
     for(size_t i=0; i<number; i++) {
         const string& name = fieldNames[i];
         if(name.empty()) {
             THROW_EXCEPTION2(std::invalid_argument, "Can't construct Structure, empty string in fieldNames");
         }
         if(fields[i].get()==NULL)
             THROW_EXCEPTION2(std::invalid_argument, "Can't construct Structure, NULL in fields");
         // look for duplicates
         for(size_t j=i+1; j<number; j++) {
             string otherName = fieldNames[j];
             int result = name.compare(otherName);
             if(result==0) {
                 string  message("Can't construct Structure, duplicate fieldName ");
                 message += name;
                 THROW_EXCEPTION2(std::invalid_argument, message);
             }
         }
     }
 }

Member Function Documentation

std::tr1::shared_ptr< PVStructure > epics::pvData::Structure::build ( ) const

Allocate a new instance

Version: Added after 7.0.0

Definition at line 661 of file FieldCreateFactory.cpp.

 {
     return getPVDataCreate()->createPVStructure(std::tr1::static_pointer_cast<const Structure>(shared_from_this()));
 }

const string & epics::pvData::Structure::defaultId ( )

static

Get the default structure ID.

Returns: The default structure ID.

Definition at line 508 of file FieldCreateFactory.cpp.

 {
     static const string id = "structure";
     return id;
 }

void epics::pvData::Structure::deserialize	(	ByteBuffer *	buffer,
		DeserializableControl *	flusher
	)

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 657 of file FieldCreateFactory.cpp.

                                                                    {
     throw std::runtime_error("not valid operation, use FieldCreate::deserialize instead");
 }

std::ostream & epics::pvData::Structure::dump ( std::ostream & o ) const

virtual

Puts the string representation to the stream.

Parameters

o	output stream.

Returns: The output stream.

Implements epics::pvData::Field.

Definition at line 595 of file FieldCreateFactory.cpp.

 {
     o << format::indent() << getID() << std::endl;
     {
         format::indent_scope s(o);
         dumpFields(o);
     }
     return o;
 }

FieldConstPtr epics::pvData::Structure::getField ( std::string const & fieldName ) const

Lookup Field by name

Parameters

fieldName Member field name. May not contain '.'

Returns: NULL if no member by this name.

template<typename FT >

std::tr1::shared_ptr<const FT> epics::pvData::Structure::getField ( std::string const & fieldName ) const

inline

Lookup Field by name and cast to Field sub-class.

Parameters

fieldName Member field name. May not contain '.'

Returns: NULL If no member by this name, or member exists, but has type other than FT.

Definition at line 734 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         return std::tr1::dynamic_pointer_cast<const FT>(getField(fieldName));
     }

const FieldConstPtr& epics::pvData::Structure::getField ( std::size_t index ) const

inline

Lookup Field by index, within this Structure.

Parameters

index

Index of member in this structure.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 772 of file pvIntrospect.h.

772 {return fields.at(index);}

template<typename FT >

std::tr1::shared_ptr<const FT> epics::pvData::Structure::getField ( std::size_t index ) const

inline

Lookup Field by index, within this Structure.

Parameters

index

Index of member in this structure.

index>=0 && index<getNumberFields()

Returns: NULL if member is not a sub-class of FT

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 780 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         return std::tr1::dynamic_pointer_cast<const FT>(getField(index));
     }

size_t epics::pvData::Structure::getFieldIndex ( std::string const & fieldName ) const

Get the field index for the specified fieldName.

Returns: The introspection interface. This will be -1 if the field is not in the structure.

Definition at line 570 of file FieldCreateFactory.cpp.

                                                              {
     size_t numberFields = fields.size();
     for(size_t i=0; i<numberFields; i++) {
         FieldConstPtr pfield = fields[i];
         int result = fieldName.compare(fieldNames[i]);
         if(result==0) return i;
     }
     return -1;
 }

const std::string& epics::pvData::Structure::getFieldName ( std::size_t fieldIndex ) const

inline

Get the name of the field with the specified index;

Parameters

fieldIndex The index of the desired field.

Returns: The fieldName.

Definition at line 834 of file pvIntrospect.h.

834 {return fieldNames.at(fieldIndex);}

StringArray const& epics::pvData::Structure::getFieldNames ( ) const

inline

Get the names of the fields in the structure.

Returns: The array of fieldNames.

Definition at line 828 of file pvIntrospect.h.

828 {return fieldNames;}

FieldConstPtrArray const& epics::pvData::Structure::getFields ( ) const

inline

Get the fields in the structure.

Returns: The array of fields.

Definition at line 823 of file pvIntrospect.h.

823 {return fields;}

FieldConstPtr epics::pvData::Structure::getFieldT ( std::string const & fieldName ) const

inline

Lookup Field by name

Parameters

fieldName Member field name. May not contain '.'

Returns: Field pointer (never NULL)

Exceptions

std::runtime_error If no member by this name

Definition at line 746 of file pvIntrospect.h.

746 {return getFieldImpl(fieldName, true);};

template<typename FT >

std::tr1::shared_ptr<const FT> epics::pvData::Structure::getFieldT ( std::string const & fieldName ) const

inline

Lookup Field by name and cast to Field sub-class.

Parameters

fieldName Member field name. May not contain '.'

Returns: Field pointer (never NULL)

Exceptions

std::runtime_error If no member by this name, or member exists, but has type other than FT.

Definition at line 754 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         std::tr1::shared_ptr<const FT> result(
             std::tr1::dynamic_pointer_cast<const FT>(getFieldT(fieldName))
         );
 
         if (!result)
             throw std::runtime_error("Wrong Field type");
 
         return result;
     }

FieldConstPtr epics::pvData::Structure::getFieldT ( std::size_t index ) const

inline

Lookup Field by index, within this Structure.

Parameters

index

Index of member in this structure.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 791 of file pvIntrospect.h.

791 {return fields.at(index);}

template<typename FT >

std::tr1::shared_ptr<const FT> epics::pvData::Structure::getFieldT ( std::size_t index ) const

inline

Lookup Field by index, within this Structure.

Parameters

index

Index of member in this structure.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range	If index >= getNumberFields()
std::runtime_error	If member is not a sub-class of FT

Definition at line 800 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         std::tr1::shared_ptr<const FT> result(
             std::tr1::dynamic_pointer_cast<const FT>(getFieldT(index))
         );
 
         if (!result)
             throw std::runtime_error("Wrong Field type");
 
         return result;
     }

string epics::pvData::Structure::getID ( ) const

virtual

Get the identification string.

Returns: The identification string, can be empty.

Implements epics::pvData::Field.

Definition at line 556 of file FieldCreateFactory.cpp.

 {
     return id;
 }

std::size_t epics::pvData::Structure::getNumberFields ( ) const

inline

Get the number of immediate subfields in the structure.

Returns: The number of fields.

Definition at line 720 of file pvIntrospect.h.

720 {return fieldNames.size();}

epics::pvData::Structure::POINTER_DEFINITIONS ( Structure )

void epics::pvData::Structure::serialize	(	ByteBuffer *	buffer,
		SerializableControl *	flusher
	)		const

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

Definition at line 651 of file FieldCreateFactory.cpp.

                                                                                 {
     control->ensureBuffer(1);
     buffer->putByte((int8)0x80);
     serializeStructureField(this, buffer, control);
 }

Friends And Related Function Documentation

friend class FieldCreate

friend

Definition at line 857 of file pvIntrospect.h.

friend class Union

friend

Definition at line 858 of file pvIntrospect.h.

Member Data Documentation

const string epics::pvData::Structure::DEFAULT_ID = Structure::defaultId()

static

Default structure ID.

Definition at line 704 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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation