From dbc5c434cbb1d998a0c7fe84300f2c053238d74e Mon Sep 17 00:00:00 2001 From: Marty Kraimer Date: Tue, 23 Sep 2014 08:50:49 -0400 Subject: [PATCH] NTField::createAlarmLimit removed; NTNameValue names,values changed to name,value --- documentation/ntCPP.html | 64 ++++++++++++++++++++-------------- src/nt/ntfield.cpp | 19 +++++------ src/nt/ntfield.h | 5 --- src/nt/ntnameValue.cpp | 20 +++++------ src/nt/ntnameValue.h | 16 ++++----- test/nt/ntfieldTest.cpp | 4 +-- test/nt/ntnameValueTest.cpp | 68 ++++++++++++++++++------------------- test/nt/ntscalarTest.cpp | 7 ++-- 8 files changed, 106 insertions(+), 97 deletions(-) diff --git a/documentation/ntCPP.html b/documentation/ntCPP.html index 1c7f237..3ea6f80 100644 --- a/documentation/ntCPP.html +++ b/documentation/ntCPP.html @@ -37,7 +37,7 @@

EPICS ntCPP

-

EPICS v4 Working Group, Working Draft, 19-Sept-2014

+

EPICS v4 Working Group, Working Draft, 22-Sept-2014

Latest version:
@@ -80,7 +80,7 @@ V4 control system programming environment:

Status of this Document

-

This is the 19-Sept-2014 version of the C++ implementation of pvData. +

This is the 22-Sept-2014 version of the C++ implementation of pvData.

@@ -138,7 +138,7 @@ The extra fields are for specialized tools. A helper class NTField is provided to enforce the proper implementation of property fields as defined by pvData. A property field is normally associated with a field that has the name "value". -The property fields currently used are alarm, timeStamp, display, control, and valueAlarm. +The property fields currently used are alarm, timeStamp, display, control, and alarmLimit. In addition pvData defines a standard structure for a value field that represents enumerated values. NTField has methods associated with each of these. @@ -172,7 +172,6 @@ public: StructureConstPtr createTimeStamp(); StructureConstPtr createAlarm(); StructureConstPtr createDisplay(); - StructureConstPtr createAlarmLimit(); StructureConstPtr createControl(); StructureArrayConstPtr createEnumeratedArray(); @@ -202,8 +201,6 @@ public:
Create an interspection interface for an alarm structure.
createDisplay
Create an introsepecion interface for a display structure.
-
createAlarmLimit
-
Create an introspection interface for an alarm limit structure.
createControl
Create an introspection interface for a control structure.
createEnumeratedArray
@@ -344,9 +341,18 @@ structure display

Note that the format should be a simplifed version of the standard C formattimg conventions.

+

enumerated

+

This is used to specify a set of choices and an index that selects one +of the choices. +For readers familiar with EPICS core this is like the ENUM types.

+
+structure
+    int index
+    string[] choices
+

alarmLimit

-

This is used to specify alarm limits for a numeric scalar value field. -It can be used by plotting tools to show alarm limits and asociated severities. +

This is used to specify alarm limits for a double scalar value field. +It can be used by plotting tools to show alarm limits and associated severities. 

 structure 
@@ -361,15 +367,23 @@ structure
     int highAlarmSeverity
     double hysteresis
-

enumerated

-

This is used to specify a set of choices and an index that selects one -of the choices. -For readers familiar with EPICS core this is like the ENUM types.

-
-structure
-    int index
-    string[] choices
-
+

NOTE: NTField, described above, has support for checking to see if +a structure is an alarmLimit structure but no other support for alarmLimit.

+ +PVData has support named valueAlarm instead of alarmLimit +(alarmLimit is identical to valueAlarm for type double). +For numeric types the field names are the same but the type +for lowAlarmLimit, lowWarningLimit, highWarningLimit, and highAlarmLimit +is based on the scalarType. +PVData also defines valueAlarm for a scalar boolean value field +and for an enumerated structure. +For these completely different field names are defined. +valueAlarm is more for use by servers than for clients. +Thus normative types only defines alarmLimit since this is what +clients like plot tools use. +If the valueAlarm fields, including alarmLimit, are desired than the standardField support from +PVData can be used to generate a valueAlarm field as an extra field. +

Normative Type Common Features

Each normative type has two classes: a builder and a class for the normative type itself.

@@ -391,13 +405,13 @@ and a method to add extra fields.

This has methods to do the following:

Create instance
-
A instance of a object can be created via a builder of from an existing PVStructure
+
A instance of a object can be created via a builder or from an existing PVStructure
Attach a Property
For the following optional fields an object to manipulate the fields can be attached: alarm, timeStamp, display, and control.
Get Data Interfaces
Each type has a method getPVStructure to get the entire data structure. - In addition there is a method to get the data interface for each manditory + In addition there is a method to get the data interface for each mandatory and optional field.

Normative Type NTScalar

@@ -477,7 +491,7 @@ where
create an PVScalar instance.
add
Add an extra field. As many fields as desired can be added but each must have - a unique name that is not the name of any manditory or possible optional field.
+ a unique name that is not the name of any mandatory or possible optional field.

An NTScalaBuilder can be used to create multiple PVStructure and/or NTScalar instances. Each time createPVScalar is called it clears all interval data after the PVStructure @@ -719,7 +733,7 @@ where

create an PVScalar instance.
add
Add an extra field. As many fields as desired can be added but each must have - a unique name that is not the name of any manditory or possible optional field.
+ a unique name that is not the name of any mandatory or possible optional field.

NTScalarArray

ntscalarArray.h defines the following:

@@ -878,7 +892,7 @@ where
create an PVScalar instance.
add
Add an extra field. As many fields as desired can be added but each must have - a unique name that is not the name of any manditory or possible optional field.
+ a unique name that is not the name of any mandatory or possible optional field.

NTNameValue

@@ -1019,7 +1033,7 @@ where
create an PVScalar instance.
add
Add an extra field. As many fields as desired can be added but each must have - a unique name that is not the name of any manditory or possible optional field.
+ a unique name that is not the name of any mandatory or possible optional field.

NTTable

@@ -1174,7 +1188,7 @@ where
       
create an PVScalar instance.

   
add

      
Add an extra field. As many fields as desired can be added but each must have
-      a unique name that is not the name of any manditory or possible optional field.

+      a unique name that is not the name of any mandatory or possible optional field.
 
 
NTMultiChannel

 
@@ -1363,7 +1377,7 @@ where
       
create an PVScalar instance.

   
add

      
Add an extra field. As many fields as desired can be added but each must have
-      a unique name that is not the name of any manditory or possible optional field.

+      a unique name that is not the name of any mandatory or possible optional field.
 
 
NTNDArray

 
diff --git a/src/nt/ntfield.cpp b/src/nt/ntfield.cpp
index 9455156..b364651 100644
--- a/src/nt/ntfield.cpp
+++ b/src/nt/ntfield.cpp
@@ -154,15 +154,23 @@ bool NTField::isAlarmLimit(FieldConstPtr const & field)
    f = fields[1];
    if(names[1].compare("lowAlarmLimit")!=0) return false;
    if(f->getType()!=scalar) return false;
+   s = static_pointer_cast(f);
+   if(s->getScalarType()!=pvDouble) return false;
    f = fields[2];
    if(names[2].compare("lowWarningLimit")!=0) return false;
    if(f->getType()!=scalar) return false;
+   s = static_pointer_cast(f);
+   if(s->getScalarType()!=pvDouble) return false;
    f = fields[3];
    if(names[3].compare("highWarningLimit")!=0) return false;
    if(f->getType()!=scalar) return false;
+   s = static_pointer_cast(f);
+   if(s->getScalarType()!=pvDouble) return false;
    f = fields[4];
    if(names[4].compare("highAlarmLimit")!=0) return false;
    if(f->getType()!=scalar) return false;
+   s = static_pointer_cast(f);
+   if(s->getScalarType()!=pvDouble) return false;
    f = fields[5];
    if(names[5].compare("lowAlarmSeverity")!=0) return false;
    if(f->getType()!=scalar) return false;
@@ -235,11 +243,6 @@ StructureConstPtr NTField::createDisplay()
     return standardField->display();
 }
 
-StructureConstPtr NTField::createAlarmLimit()
-{
-    return standardField->doubleAlarm();
-}
-
 StructureConstPtr NTField::createControl()
 {
     return standardField->control();
@@ -306,12 +309,6 @@ PVStructurePtr PVNTField::createDisplay()
     return pvDataCreate->createPVStructure(display);
 }
 
-PVStructurePtr PVNTField::createAlarmLimit()
-{
-    StructureConstPtr structure = NTField::get()->createAlarmLimit();
-    return pvDataCreate->createPVStructure(structure);
-}
-
 
 PVStructurePtr PVNTField::createControl()
 {
diff --git a/src/nt/ntfield.h b/src/nt/ntfield.h
index 3314051..da70787 100644
--- a/src/nt/ntfield.h
+++ b/src/nt/ntfield.h
@@ -99,11 +99,6 @@ public:
      * @return a displayalarm structure.
      */
     StructureConstPtr createDisplay();
-    /**
-     * Create an alarmLimit structure.
-     * @return an alarmLimit structure.
-     */
-    StructureConstPtr createAlarmLimit();
     /**
      * Create a control structure.
      * @return a control structure.
diff --git a/src/nt/ntnameValue.cpp b/src/nt/ntnameValue.cpp
index 5708381..bf6f0da 100644
--- a/src/nt/ntnameValue.cpp
+++ b/src/nt/ntnameValue.cpp
@@ -34,8 +34,8 @@ StructureConstPtr NTNameValueBuilder::createStructure()
     FieldBuilderPtr builder =
             getFieldCreate()->createFieldBuilder()->
                setId(NTNameValue::URI)->
-               addArray("names", pvString)->
-               addArray("values", valueType);
+               addArray("name", pvString)->
+               addArray("value", valueType);
 
     if (descriptor)
         builder->add("descriptor", pvString);
@@ -130,10 +130,10 @@ bool NTNameValue::is_a(StructureConstPtr const & structure)
 
 bool NTNameValue::is_compatible(PVStructurePtr const & pvStructure)
 {
-    PVStringArrayPtr pvNames = pvStructure->getSubField("names");
-    if(!pvNames) return false;
-    PVFieldPtr pvValues = pvStructure->getSubField("values");
-    if(!pvValues) return false;
+    PVStringArrayPtr pvName = pvStructure->getSubField("name");
+    if(!pvName) return false;
+    PVFieldPtr pvValue = pvStructure->getSubField("value");
+    if(!pvValue) return false;
     PVFieldPtr pvField = pvStructure->getSubField("descriptor");
     if(pvField && !pvStructure->getSubField("descriptor")) return false;
     pvField = pvStructure->getSubField("alarm");
@@ -186,14 +186,14 @@ PVStructurePtr NTNameValue::getAlarm() const
     return pvNTNameValue->getSubField("alarm");
 }
 
-PVStringArrayPtr NTNameValue::getNames() const
+PVStringArrayPtr NTNameValue::getName() const
 {
-    return pvNTNameValue->getSubField("names");
+    return pvNTNameValue->getSubField("name");
 }
 
-PVFieldPtr NTNameValue::getValues() const
+PVFieldPtr NTNameValue::getValue() const
 {
-    return pvNTNameValue->getSubField("values");
+    return pvNTNameValue->getSubField("value");
 }
 
 NTNameValue::NTNameValue(PVStructurePtr const & pvStructure) :
diff --git a/src/nt/ntnameValue.h b/src/nt/ntnameValue.h
index f9413af..af48582 100644
--- a/src/nt/ntnameValue.h
+++ b/src/nt/ntnameValue.h
@@ -200,25 +200,25 @@ public:
     epics::pvData::PVStructurePtr getAlarm() const;
 
     /**
-     * Get the names array field.
-     * @return The PVStringArray for the names.
+     * Get the name array field.
+     * @return The PVStringArray for the name.
      */
-    epics::pvData::PVStringArrayPtr getNames() const;
+    epics::pvData::PVStringArrayPtr getName() const;
 
     /**
      * Get the value array field.
-     * @return The PVField for the values.
+     * @return The PVField for the value.
      */
-    epics::pvData::PVFieldPtr getValues() const;
+    epics::pvData::PVFieldPtr getValue() const;
 
     /**
      * Get the value array field of a specified type (e.g. PVDoubleArray).
-     * @return The  array for the values.
+     * @return The  array for the value.
      */
     template
-    std::tr1::shared_ptr getValues() const
+    std::tr1::shared_ptr getValue() const
     {
-        epics::pvData::PVFieldPtr pvField = getValues();
+        epics::pvData::PVFieldPtr pvField = getValue();
         if (pvField.get())
             return std::tr1::dynamic_pointer_cast(pvField);
         else
diff --git a/test/nt/ntfieldTest.cpp b/test/nt/ntfieldTest.cpp
index a49fe7b..f394533 100644
--- a/test/nt/ntfieldTest.cpp
+++ b/test/nt/ntfieldTest.cpp
@@ -47,7 +47,7 @@ void testNTField()
     cout << *structureConstPtr << endl;
     testOk1(ntField->isDisplay(structureConstPtr));
 
-    structureConstPtr = ntField->createAlarmLimit();
+    structureConstPtr = standardField->doubleAlarm();
     cout << *structureConstPtr << endl;
     testOk1(ntField->isAlarmLimit(structureConstPtr));
 
@@ -92,7 +92,7 @@ void testPVNTField()
     cout << *pvStructure << endl;
     testOk1(ntField->isDisplay(pvStructure->getStructure()));
 
-    pvStructure = PVStructurePtr(pvntField->createAlarmLimit());
+    pvStructure = PVStructurePtr(pvDataCreate->createPVStructure(standardField->doubleAlarm()));
     cout << *pvStructure << endl;
     testOk1(ntField->isAlarmLimit(pvStructure->getStructure()));
 
diff --git a/test/nt/ntnameValueTest.cpp b/test/nt/ntnameValueTest.cpp
index cffe7ab..f80357f 100644
--- a/test/nt/ntnameValueTest.cpp
+++ b/test/nt/ntnameValueTest.cpp
@@ -37,14 +37,14 @@ void test_builder()
     testOk1(NTNameValue::is_a(structure));
     testOk1(structure->getID() == NTNameValue::URI);
     testOk1(structure->getNumberFields() == 7);
-    testOk1(structure->getField("names").get() != 0);
-    testOk1(structure->getField("values").get() != 0);
+    testOk1(structure->getField("name").get() != 0);
+    testOk1(structure->getField("value").get() != 0);
     testOk1(structure->getField("descriptor").get() != 0);
     testOk1(structure->getField("alarm").get() != 0);
     testOk1(structure->getField("timeStamp").get() != 0);
 
-    testOk(dynamic_pointer_cast(structure->getField("values")).get() != 0 &&
-            dynamic_pointer_cast(structure->getField("values"))->getElementType() == pvDouble, "value array element type");
+    testOk(dynamic_pointer_cast(structure->getField("value")).get() != 0 &&
+            dynamic_pointer_cast(structure->getField("value"))->getElementType() == pvDouble, "value array element type");
 
     std::cout << *structure << std::endl;
 
@@ -85,50 +85,50 @@ void test_ntnameValue()
     testOk1(ntNameValue->getDescriptor().get() != 0);
     testOk1(ntNameValue->getAlarm().get() != 0);
     testOk1(ntNameValue->getTimeStamp().get() != 0);
-    testOk1(ntNameValue->getNames().get() != 0);
-    testOk1(ntNameValue->getValues().get() != 0);
+    testOk1(ntNameValue->getName().get() != 0);
+    testOk1(ntNameValue->getValue().get() != 0);
 
     //
-    // example how to set names
+    // example how to set name
     //
-    PVStringArray::svector newNames;
-    newNames.push_back("name1");
-    newNames.push_back("name2");
-    newNames.push_back("name3");
+    PVStringArray::svector newName;
+    newName.push_back("name1");
+    newName.push_back("name2");
+    newName.push_back("name3");
 
-    PVStringArrayPtr pvNamesField = ntNameValue->getNames();
-    pvNamesField->replace(freeze(newNames));
+    PVStringArrayPtr pvNameField = ntNameValue->getName();
+    pvNameField->replace(freeze(newName));
 
     //
-    // example how to get names
+    // example how to get name
     //
-    PVStringArray::const_svector names(pvNamesField->view());
+    PVStringArray::const_svector name(pvNameField->view());
 
-    testOk1(names.size() == 3);
-    testOk1(names[0] == "name1");
-    testOk1(names[1] == "name2");
-    testOk1(names[2] == "name3");
+    testOk1(name.size() == 3);
+    testOk1(name[0] == "name1");
+    testOk1(name[1] == "name2");
+    testOk1(name[2] == "name3");
 
     //
-    // example how to set values
+    // example how to set value
     //
-    PVIntArray::svector newValues;
-    newValues.push_back(1);
-    newValues.push_back(2);
-    newValues.push_back(8);
+    PVIntArray::svector newValue;
+    newValue.push_back(1);
+    newValue.push_back(2);
+    newValue.push_back(8);
 
-    PVIntArrayPtr pvValueField = ntNameValue->getValues();
-    pvValueField->replace(freeze(newValues));
+    PVIntArrayPtr pvValueField = ntNameValue->getValue();
+    pvValueField->replace(freeze(newValue));
 
     //
-    // example how to get column values
+    // example how to get column value
     //
-    PVIntArray::const_svector values(pvValueField->view());
+    PVIntArray::const_svector value(pvValueField->view());
 
-    testOk1(values.size() == 3);
-    testOk1(values[0] == 1);
-    testOk1(values[1] == 2);
-    testOk1(values[2] == 8);
+    testOk1(value.size() == 3);
+    testOk1(value[0] == 1);
+    testOk1(value[1] == 2);
+    testOk1(value[2] == 8);
 
     //
     // timeStamp ops
@@ -232,8 +232,8 @@ void test_extra()
     testOk1(NTNameValue::is_a(structure));
     testOk1(structure->getID() == NTNameValue::URI);
     testOk1(structure->getNumberFields() == 4);
-    testOk1(structure->getField("names").get() != 0);
-    testOk1(structure->getField("values").get() != 0);
+    testOk1(structure->getField("name").get() != 0);
+    testOk1(structure->getField("value").get() != 0);
     testOk1(structure->getField("timeStamp").get() != 0);
     testOk1(structure->getField("function").get() != 0);
 
diff --git a/test/nt/ntscalarTest.cpp b/test/nt/ntscalarTest.cpp
index 012e203..413f6bd 100644
--- a/test/nt/ntscalarTest.cpp
+++ b/test/nt/ntscalarTest.cpp
@@ -9,11 +9,13 @@
 
 #include 
 
+
 using namespace epics::nt;
 using namespace epics::pvData;
 using std::tr1::dynamic_pointer_cast;
 
 static FieldCreatePtr fieldCreate = getFieldCreate();
+static StandardFieldPtr standardField = getStandardField();
 void test_builder()
 {
     testDiag("test_builder");
@@ -28,8 +30,8 @@ void test_builder()
             addTimeStamp()->
             addDisplay()->
             addControl()->
-            add("extra1",fieldCreate->createScalar(pvString)) ->
-            add("extra2",fieldCreate->createScalarArray(pvString)) ->
+            add("valueAlarm",standardField->doubleAlarm()) ->
+            add("extra",fieldCreate->createScalarArray(pvString)) ->
             createStructure();
     testOk1(structure.get() != 0);
     if (!structure)
@@ -80,6 +82,7 @@ void test_ntscalar()
             addTimeStamp()->
             addDisplay()->
             addControl()->
+            add("valueAlarm",standardField->intAlarm()) ->
             create();
     testOk1(ntScalar.get() != 0);