epics::pvData::PVField Class Reference

PVField is the base class for each PVData field. More...

#include "pvData.h"

Inheritance diagram for epics::pvData::PVField:

Collaboration diagram for epics::pvData::PVField:

Public Types
enum	{ isPVField =1 }

Public Member Functions
	POINTER_DEFINITIONS (PVField)
virtual	~PVField ()
const std::string &	getFieldName () const
std::string	getFullName () const
std::size_t	getFieldOffset () const
std::size_t	getNextFieldOffset () const
std::size_t	getNumberFields () const
bool	isImmutable () const
virtual void	setImmutable ()
const FieldConstPtr &	getField () const
PVStructure *	getParent ()
const PVStructure *	getParent () const
void	postPut ()
void	setPostHandler (PostHandlerPtr const &postHandler)
virtual bool	equals (PVField &pv)
virtual std::ostream &	dumpValue (std::ostream &o) const =0
void	copy (const PVField &from)
void	copyUnchecked (const PVField &from)
Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()
virtual void	serialize (ByteBuffer *buffer, SerializableControl *flusher) const =0
virtual void	deserialize (ByteBuffer *buffer, DeserializableControl *flusher)=0

Static Public Attributes
static size_t	num_instances

Protected Member Functions
PVField::shared_pointer	getPtrSelf ()
	PVField (FieldConstPtr field)
void	setParentAndName (PVStructure *parent, std::string const &fieldName)

Friends
class	PVDataCreate
class	PVStructure

Detailed Description

PVField is the base class for each PVData field.

Each PVData field has an interface that extends PVField.

Definition at line 152 of file pvData.h.

Member Enumeration Documentation

anonymous enum

Enumerator
isPVField

Definition at line 242 of file pvData.h.

{isPVField=1};

Constructor & Destructor Documentation

epics::pvData::PVField::~PVField ( )

virtual

Destructor

Definition at line 38 of file PVField.cpp.

{
    REFTRACE_DECREMENT(num_instances);
}

epics::pvData::PVField::PVField ( FieldConstPtr  field )

explicitprotected

Definition at line 30 of file PVField.cpp.

: parent(NULL),field(field),
  fieldOffset(0), nextFieldOffset(0),
  immutable(false)
{
    REFTRACE_INCREMENT(num_instances);
}

Member Function Documentation

void epics::pvData::PVField::copy

(

const PVField &

from

)

Definition at line 182 of file PVField.cpp.

{
    if(isImmutable())
        throw std::invalid_argument("destination is immutable");

    if (getField() != from.getField())
        throw std::invalid_argument("field types do not match");

    copyUnchecked(from);
}

void epics::pvData::PVField::copyUnchecked

(

const PVField &

from

)

Definition at line 193 of file PVField.cpp.

{
    assert(getField()==from.getField());

    switch(getField()->getType())
    {
    case scalar:
        {
             const PVScalar* fromS = static_cast<const PVScalar*>(&from);
             PVScalar* toS = static_cast<PVScalar*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    case scalarArray:
        {
             const PVScalarArray* fromS = static_cast<const PVScalarArray*>(&from);
             PVScalarArray* toS = static_cast<PVScalarArray*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    case structure:
        {
             const PVStructure* fromS = static_cast<const PVStructure*>(&from);
             PVStructure* toS = static_cast<PVStructure*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    case structureArray:
        {
             const PVStructureArray* fromS = static_cast<const PVStructureArray*>(&from);
             PVStructureArray* toS = static_cast<PVStructureArray*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    case union_:
        {
             const PVUnion* fromS = static_cast<const PVUnion*>(&from);
             PVUnion* toS = static_cast<PVUnion*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    case unionArray:
        {
             const PVUnionArray* fromS = static_cast<const PVUnionArray*>(&from);
             PVUnionArray* toS = static_cast<PVUnionArray*>(this);
             toS->copyUnchecked(*fromS);
             break;
        }
    default:
        {
            throw std::logic_error("PVField::copy unknown type");
        }
    }
}

virtual std::ostream& epics::pvData::PVField::dumpValue ( std::ostream &  o ) const

pure virtual

Puts the PVField raw value to the stream.

Parameters

o	output stream.

Returns

The output stream.

Implemented in epics::pvData::PVValueArray< PVUnionPtr >, epics::pvData::PVValueArray< PVStructurePtr >, epics::pvData::PVValueArray< T >, epics::pvData::PVUnion, epics::pvData::PVStructure, epics::pvData::PVString, epics::pvData::PVScalarValue< T >, epics::pvData::PVScalarValue< T >, epics::pvData::PVScalarValue< T >, epics::pvData::PVScalarValue< T >, epics::pvData::PVScalarValue< std::string >, and epics::pvData::PVValueArray< T >.

bool epics::pvData::PVField::equals ( PVField &  pv )

virtual

Is this field equal to another field.

Parameters

pv	other field

Returns

(false,true) if (is not,is) equal.

Definition at line 87 of file PVField.cpp.

{
    return pv==*this;
}

const FieldConstPtr& epics::pvData::PVField::getField ( ) const

inline

Get the Field that describes the field.

Returns

Field, which is the reflection interface.

Definition at line 208 of file pvData.h.

{return field;}

const std::string& epics::pvData::PVField::getFieldName ( ) const

inline

Get the fieldName for this field.

Returns

The name or empty string if top-level field.

Definition at line 166 of file pvData.h.

{return fieldName;}

size_t epics::pvData::PVField::getFieldOffset

(

)

const

Get offset of the PVField field within top-level structure. Every field within the PVStructure has a unique offset. The top-level structure has an offset of 0. The first field within the structure has offset equal to 1. The other offsets are determined by recursively traversing each structure of the tree.

Returns

The offset.

Definition at line 44 of file PVField.cpp.

{
    if(nextFieldOffset==0) computeOffset(this);
    return fieldOffset;
}

string epics::pvData::PVField::getFullName

(

)

const

Fully expand the name of this field using the names of its parent fields with a dot '.' separating each name.

Definition at line 97 of file PVField.cpp.

{
    string ret(fieldName);
    for(const PVField *fld=getParent(); fld; fld=fld->getParent())
    {
        if(fld->getFieldName().size()==0) break;
        ret = fld->getFieldName() + '.' + ret;
    }
    return ret;
}

size_t epics::pvData::PVField::getNextFieldOffset

(

)

const

Get the next offset. If the field is a scalar or array field then this is just offset + 1. If the field is a structure it is the offset of the next field after this structure. Thus (nextOffset - offset) is always equal to the number of fields within the field.

Returns

The offset.

Definition at line 50 of file PVField.cpp.

{
    if(nextFieldOffset==0) computeOffset(this);
    return nextFieldOffset;
}

size_t epics::pvData::PVField::getNumberFields

(

)

const

Get the total number of fields in this field. This is equal to nextFieldOffset - fieldOffset.

Definition at line 56 of file PVField.cpp.

{
    if(nextFieldOffset==0) computeOffset(this);
    return (nextFieldOffset - fieldOffset);
}

PVStructure* epics::pvData::PVField::getParent ( )

inline

Get the parent of this field.

Returns

The parent interface or null if this is PVRecord

Definition at line 213 of file pvData.h.

{return parent;}

const PVStructure* epics::pvData::PVField::getParent ( ) const

inline

Definition at line 214 of file pvData.h.

{return parent;}

PVField::shared_pointer epics::pvData::PVField::getPtrSelf ( )

inlineprotected

Definition at line 244 of file pvData.h.

    {
        return shared_from_this();
    }

bool epics::pvData::PVField::isImmutable ( ) const

inline

Is the field immutable, i.e. does it not allow changes.

Returns

(false,true) if it (is not, is) immutable.

Definition at line 198 of file pvData.h.

{return immutable;}

epics::pvData::PVField::POINTER_DEFINITIONS

(

PVField

)

void epics::pvData::PVField::postPut

(

)

postPut. Called when the field is updated by the implementation.

Definition at line 65 of file PVField.cpp.

{
   if(postHandler) postHandler->postPut();
}

void epics::pvData::PVField::setImmutable ( )

virtual

Set the field to be immutable, i.e. it can no longer be modified. This is permanent, i.e. once done the field cannot be made mutable.

Reimplemented in epics::pvData::PVStructure, and epics::pvData::PVArray.

Definition at line 63 of file PVField.cpp.

{immutable = true;}

void epics::pvData::PVField::setParentAndName ( PVStructure *  parent, std::string const &  fieldName  )

protected

Definition at line 81 of file PVField.cpp.

{
    parent = xxx;
    fieldName = name;
}

void epics::pvData::PVField::setPostHandler

(

PostHandlerPtr const &

postHandler

)

Set the handler for postPut. At most one handler can be set.

Parameters

postHandler

The handler.

Definition at line 70 of file PVField.cpp.

{
    if(postHandler) {
        if(postHandler.get()==handler.get()) return;
        throw std::logic_error(
            "PVField::setPostHandler a postHandler is already registered");

    }
    postHandler = handler;
}

Friends And Related Function Documentation

friend class PVDataCreate

friend

Definition at line 260 of file pvData.h.

friend class PVStructure

friend

Definition at line 261 of file pvData.h.

Member Data Documentation

size_t epics::pvData::PVField::num_instances

static

Definition at line 241 of file pvData.h.

---

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

• modules/pvData/src/pv/pvData.h
• modules/pvData/src/factory/PVField.cpp