epics::pvData::PVEnumerated Class Reference

Methods for accessing an enumerated structure. More...

#include "pvEnumerated.h"

Public Member Functions
	PVEnumerated ()
bool	attach (PVFieldPtr const &pvField)
void	detach ()
bool	isAttached ()
bool	setIndex (int32 index)
int32	getIndex ()
std::string	getChoice ()
bool	choicesMutable ()
PVStringArray::const_svector	getChoices ()
int32	getNumberChoices ()
bool	setChoices (const StringArray &choices)

Detailed Description

Methods for accessing an enumerated structure.

An enumerated structure has the following fields:

structure
    int index
    string[] choices

This class can be attached to an enumerated structure field of any PVData object. The methods provide access to the fields in the attached structure. This class should not be extended.

Definition at line 34 of file pvEnumerated.h.

Constructor & Destructor Documentation

epics::pvData::PVEnumerated::PVEnumerated ( )

inline

Definition at line 39 of file pvEnumerated.h.

{}

Member Function Documentation

bool epics::pvData::PVEnumerated::attach

(

PVFieldPtr const &

pvField

)

Definition at line 26 of file pvEnumerated.cpp.

{
    if(pvField->getField()->getType()!=structure) return false;
    PVStructurePtr pvStructure = static_pointer_cast<PVStructure>(pvField);
    pvIndex = pvStructure->getSubField<PVInt>("index");
    if(pvIndex.get()==NULL) return false;
    PVStringArrayPtr pvStringArray = pvStructure->getSubField<PVStringArray>("choices");
    if(pvStringArray.get()==NULL) {
        pvIndex.reset();
        return false;
    }
    pvChoices = pvStringArray;
    return true;
}

bool epics::pvData::PVEnumerated::choicesMutable

(

)

Can choices be changed?

Returns

(false,true) if choices (can not, can) be changed.

Exceptions

if	not attached.

Definition at line 84 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    return pvChoices->isImmutable();
}

void epics::pvData::PVEnumerated::detach

(

)

Detach for pvField.

Definition at line 41 of file pvEnumerated.cpp.

{
    pvIndex.reset();
    pvChoices.reset();
}

string epics::pvData::PVEnumerated::getChoice

(

)

Get the choice corresponding to current index.

Returns

The choice. If index is out of range a null string is returned.

Exceptions

if	not attached.

Definition at line 70 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    size_t index = pvIndex->get();
    const PVStringArray::const_svector& data(pvChoices->view());
    if(/*index<0 ||*/ index>=data.size()) {
        string nullString;
        return nullString;
    }
    return data[index];
}

PVStringArray::const_svector epics::pvData::PVEnumerated::getChoices ( )

inline

Get the choices.

Returns

The current index.

Exceptions

if	not attached.

Definition at line 91 of file pvEnumerated.h.

{return pvChoices->view();}

int32 epics::pvData::PVEnumerated::getIndex

(

)

Get the index.

Returns

The current index.

Exceptions

if	not attached.

Definition at line 62 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    return pvIndex->get();
}

int32 epics::pvData::PVEnumerated::getNumberChoices

(

)

Get the size of the choices array.

Returns

The size.

Exceptions

if	not attached.

Definition at line 92 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    return static_cast<int32>(pvChoices->getLength());
}

bool epics::pvData::PVEnumerated::isAttached

(

)

Is the PVEnumerated attached to a pvField?

Returns

(false,true) (is not,is) attached to a pvField.

Definition at line 47 of file pvEnumerated.cpp.

                              {
    if(pvIndex.get()==NULL) return false;
    return true;
}

bool epics::pvData::PVEnumerated::setChoices

(

const StringArray &

choices

)

Get the choices.

Parameters

choices

The new value for choices.`

Returns

(false,true) if choices (was not was) replaced.

Exceptions

if	not attached.

Definition at line 100 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    if(pvChoices->isImmutable()) return false;
    PVStringArray::svector data(choices.size());
    std::copy(choices.begin(), choices.end(), data.begin());
    pvChoices->replace(freeze(data));
    return true;
}

bool epics::pvData::PVEnumerated::setIndex

(

int32

index

)

Set the index.

Parameters

index

The new index.

Exceptions

if	not attached. The index will be changed even if it is out of range of size of choices.

Definition at line 52 of file pvEnumerated.cpp.

{
    if(pvIndex.get()==NULL ) {
         throw std::logic_error(notAttached);
    }
    if(pvIndex->isImmutable()) return false;
    pvIndex->put(index);
    return true;
}

---

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

• modules/pvData/src/property/pv/pvEnumerated.h
• modules/pvData/src/property/pvEnumerated.cpp