lots of code is a copy paste, consider inheritance and templates
\ No newline at end of file +NTScalarArrayBuilder::arrayValue
+Should this be:
+NTScalarArrayBuilder::value
+This makes NTScalarArray consistent with other NTTypes.
+This does not have a value field like all the other NTTypes. +Perhaps instead of
+NTNameValue
+ string[] name
+ string[] value
+It should be
+NTNameValue
+ value
+ string[] name
+ string[] value
+Should lables be label? +Compare with name,value from NTNameValue.
\ No newline at end of file diff --git a/documentation/TODO.md b/documentation/TODO.md index e6edb22..044b06c 100644 --- a/documentation/TODO.md +++ b/documentation/TODO.md @@ -1,4 +1,37 @@ TODO =========== -lots of code is a copy paste, consider inheritance and templates +NTScalarArray +------------ + +NTScalarArrayBuilder::arrayValue + +Should this be: + +NTScalarArrayBuilder::value + +This makes NTScalarArray consistent with other NTTypes. + + +NTNameValue +------------ + +This does not have a value field like all the other NTTypes. +Perhaps instead of + + NTNameValue + string[] name + string[] value + +It should be + + NTNameValue + value + string[] name + string[] value + +NTTable +---------- + +Should lables be label? +Compare with name,value from NTNameValue. diff --git a/documentation/ntCPP.html b/documentation/ntCPP.html index c29ca30..7722c64 100644 --- a/documentation/ntCPP.html +++ b/documentation/ntCPP.html @@ -37,7 +37,7 @@This is the 01-Oct-2014 version of the C++ implementation of pvData. +
This is the 09-Oct-2014 version of the C++ implementation of pvData.
@@ -112,9 +112,9 @@ pvDataCPP.htmlOften a property field is associated with another field. -This other field is refered to as the value field. +This other field is referred to as the value field. Usually the value field will have the field name "value". An example is:
@@ -233,9 +233,11 @@ to report problems to the client. An alarm attached to a substructure of the top level structure is normally associated with a value field. An alarm field attached to the top level structure can be used for either: +
- If the top level structure has a value field then it is an alarm for that field. +
- To report other problems to the client.
If alarms do appear at multiple levels then an alarm is always @@ -269,7 +271,7 @@ structure alarm string message
Clients and Servers should use alarm.h and pvAlarm.h which are -provided by pvDataCPP intead of directly using the alarm structure itself. +provided by pvDataCPP instead of directly using the alarm structure itself. In particular severity and status are defined as:
enum AlarmSeverity {
@@ -288,9 +290,11 @@ There can be multiple timeStamp fields.
A timeStamp associated with a substructure is usually associated with
a value field.
An timeStamp field attached to the top level structure can be used for either:
+
- If the top level structure has a value field then it can be the
timeStamp for that field.
+
- The time when the server executed.
NTNDArray is an example that has two top level timeStamp field with different
@@ -304,7 +308,7 @@ structure timeStamp
int userTag
Clients and Servers should use timeStamp.h and pvTimeStamp.h -which are provided by pvDataCPP intead of directly using the timeStamp structure itself. +which are provided by pvDataCPP instead of directly using the timeStamp structure itself. Note that timeStamp.h provides many methods for manipulating time.
The meaning of the fields is:
@@ -326,7 +330,7 @@ structure control double minStepServers should use control.h and pvControl.h which are -provided by pvDataCPP intead of directly using the control structure itself. +provided by pvDataCPP instead of directly using the control structure itself. Note that control.h provides many methods for manipulating time.
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 @@ -394,8 +398,9 @@ PVData can be used to generate a valueAlarm field as an extra field.
Each bulder also has a number of additional methods for optional fields @@ -417,7 +422,7 @@ This has methods to do the following:
This has the following fields:
-ev4:nt/NTScalar:1.0
+epics:nt/NTScalar:1.0
double value // mandatory and can be any numeric type
string descriptor // optional
alarm_t alarm // optional
@@ -494,13 +499,13 @@ where
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
+Each time createPVScalar is called it clears all internal data after the PVStructure
is created.
NTScalarBuilder Examples
An example of creating an NTScalar instance is:
NTScalarBuilderPtr builder = NTScalar::createBuilder();
-NTScalarPtr ntScalar = builder->
+NTScalarPtr ntScalar = builder->
value(pvInt)->
addDescriptor()->
addAlarm()->
@@ -525,7 +530,7 @@ NTScalarPtr ntScalar = builder->create();
ntscalar.h defines the following:
class NTScalar;
-typedef std::tr1::shared_ptr NTScalarPtr;
+typedef std::tr1::shared_ptr<NTScalar> NTScalarPtr;
class NTScalar
{
@@ -549,7 +554,7 @@ public:
PVStructurePtr getControl() const;
PVFieldPtr getValue() const;
template<typename PVT>
- std::tr1::shared_ptr<PV> getValue() const
+ std::tr1::shared_ptr<PVT> getValue() const
private:
}
@@ -557,12 +562,13 @@ where
void myCallback(PVStructurePtr const & pvStructure)
@@ -574,7 +580,7 @@ void myCallback(PVStructurePtr const & pvStructure)
...
}
- This class is similar to NTScalarArray except that the value +
This class is similar to NTScalar except that the value field is a scalar array field instead of just a scalar.
This has the following fields:
-ev4:nt/NTScalarArray:1.0
+epics:nt/NTScalarArray:1.0
double[] value // mandatory and can be any numeric type
string descriptor // optional
alarm_t alarm // optional
@@ -711,7 +717,7 @@ private:
where
ntscalarArray.h defines the following:
class NTScalarArray; -typedef std::tr1::shared_ptrNTScalarArrayPtr; +typedef std::tr1::shared_ptr<NTScalarArray> NTScalarArrayPtr; class NTScalarArray { @@ -771,7 +777,7 @@ where - wrap
- Given a pvStructure this creates an NTScalarArray that warps it. It calls isCompatible returns a null PVScalarArray if isCompatible returns false. -
- +
- wrapUnsafe
- Given a pvStructure this creates an NTScalarArray that warps it. It does not check that the introspection interface is compatible. @@ -832,9 +838,9 @@ where
Normative Type NTNameValue
-ev4:nt/NTNameValue:1.0 - string[] names // mandatory - double[] values // madatory, can be any type, must be same length as names +epics:nt/NTNameValue:1.0 + string[] name // mandatory + double[] value // madatory, can be any type, must be same length as name string descriptor // optional alarm_t alarm // optional int severity @@ -896,7 +902,7 @@ whereNTNameValue
class NTNameValue; -typedef std::tr1::shared_ptrNTNameValuePtr; +typedef std::tr1::shared_ptr<NTNameValue> NTNameValuePtr; class NTNameValue { @@ -911,11 +917,12 @@ public: bool attachTimeStamp(PVTimeStamp &pvTimeStamp) const; bool attachAlarm(PVAlarm &pvAlarm) const; + PVStringPtr getDescriptor() const; PVStructurePtr getPVStructure() const; PVStructurePtr getTimeStamp() const; PVStructurePtr getAlarm() const; - PVStringArrayPtr getNames() const; - PVFieldPtr getValues() const; + PVStringArrayPtr getName() const; + PVFieldPtr getValue() const; template<typename PVT> std::tr1::shared_ptr<PV> getValue() const private: @@ -926,7 +933,7 @@ where - wrap
- Given a pvStructure this creates an NTNameValue that warps it. It calls isCompatible returns a null NTNameValue if isCompatible returns false. -
- +
- wrapUnsafe
- Given a pvStructure this creates an NTNameValue that warps it. It does not check that the introspection interface is compatible. @@ -963,15 +970,15 @@ where If the alarm was not selected as an optional field a null pvStructure is returned.
-- getNames
-- Returns field names.
-- getValues
-- Returns field values.
+- getName
+- Returns field name.
+- getValue
+- Returns field value.
-ev4:nt/NTTable:1.0
+epics:nt/NTTable:1.0
string[] labels [column0,column1,column2] // mandatory
structure value // mandatory;
double[] column0 [] // name=labels[0]; can be any scalar type
@@ -1035,7 +1042,7 @@ where
NTTable
class NTTable;
-typedef std::tr1::shared_ptr NTTablePtr;
+typedef std::tr1::shared_ptr<NTTable> NTTablePtr;
class NTTable
{
@@ -1066,7 +1073,7 @@ where
wrap
Given a pvStructure this creates an NTTable that warps it.
It calls isCompatible returns a null NTTable if isCompatible returns false.
-
+
wrapUnsafe
Given a pvStructure this creates an NTTable that warps it.
It does not check that the introspection interface is compatible.
@@ -1189,7 +1196,7 @@ where
NTMultiChannel
class NTMultiChannel;
-typedef std::tr1::shared_ptr NTMultiChannelPtr;
+typedef std::tr1::shared_ptr<NTMultiChannel> NTMultiChannelPtr;
class NTMultiChannel
{
@@ -1204,6 +1211,7 @@ public:
bool attachTimeStamp(PVTimeStamp &pvTimeStamp) const;
bool attachAlarm(PVAlarm &pvAlarm) const;
+ PVStringPtr getDescriptor() const;
PVStructurePtr getPVStructure() const;
PVStructurePtr getTimeStamp() const;
PVStructurePtr getAlarm() const;
@@ -1216,9 +1224,6 @@ public:
PVLongArrayPtr getSecondsPastEpoch() const;
PVIntArrayPtr getNanoseconds() const;
PVIntArrayPtr getUserTag() const;
- PVStringPtr getDescriptor() const;
- template<typename PVT>
- std::tr1::shared_ptr<PV> getValue() const
private:
}
@@ -1227,7 +1232,7 @@ where
wrap
Given a pvStructure this creates an NTMultiChannel that warps it.
It calls isCompatible returns a null NTMultiChannel if isCompatible returns false.
-
+
wrapUnsafe
Given a pvStructure this creates an NTMultiChannel that warps it.
It does not check that the introspection interface is compatible.
@@ -1286,13 +1291,13 @@ where
Normative Type NTNDArray
-ev4:nt/NTNDArray:1.0
+epics:nt/NTNDArray:1.0
union value //mandatory
- long compressedSize //mandatory
- long uncompressedSize //mandatory
codec_t codec //mandatory
string name
any parameters
+ long compressedSize //mandatory
+ long uncompressedSize //mandatory
dimension_t[] dimension //mandatory
dimension_t[]
dimension_t
@@ -1306,9 +1311,9 @@ ev4:nt/NTNDArray:1.0
long secondsPastEpoch
int nanoseconds
int userTag
- ev4:nt/NTAttribute:1.0[] attribute //mandatory
- ev4:nt/NTAttribute:1.0[]
- ev4:nt/NTAttribute:1.0
+ epics:nt/NTAttribute:1.0[] attribute //mandatory
+ epics:nt/NTAttribute:1.0[]
+ epics:nt/NTAttribute:1.0
string name
any value
string description
@@ -1377,7 +1382,7 @@ where
NTNDArray
class NTNDArray;
-typedef std::tr1::shared_ptr NTNDArrayPtr;
+typedef std::tr1::shared_ptr<NTNDArray> NTNDArrayPtr;
class NTNDArray
{
@@ -1390,20 +1395,21 @@ public:
static bool isComparible(PVStructurePtr const &pvStructure);
static NTNDArrayBuilderPtr createBuilder();
+ PVStringPtr getDescriptor() const;
bool attachTimeStamp(PVTimeStamp &pvTimeStamp) const;
bool attachDataTimeStamp(PVTimeStamp &pvTimeStamp) const;
bool attachAlarm(PVAlarm &pvAlarm) const;
PVStructurePtr getPVStructure() const;
PVUnionPtr getValue() const;
+ PVStructurePtr getCodec() const;
PVLongPtr getCompressedDataSize() const;
PVLongPtr getUncompressedDataSize() const;
- PVStructurePtr getCodec() const;
PVStructureArrayPtr getAttribute() const;
PVStructureArrayPtr getDimension() const;
PVIntPtr getUniqueId() const;
- PVStructurePtr getTimeStamp() const;
PVStructurePtr getDataTimeStamp() const;
PVStringPtr getDescriptor() const;
+ PVStructurePtr getTimeStamp() const;
PVStructurePtr getAlarm() const;
PVStructurePtr getDisplay() const;
private:
@@ -1414,7 +1420,7 @@ where
wrap
Given a pvStructure this creates an NTNDArray that warps it.
It calls isCompatible returns a null NTNDArray if isCompatible returns false.
-
+
wrapUnsafe
Given a pvStructure this creates an NTNDArray that warps it.
It does not check that the introspection interface is compatible.
@@ -1442,6 +1448,23 @@ where
getPVStructure
Returns the pvStructure that NTNDArray wraps.
+ getValue
+ Returns the value field.
+ getCodec
+ Returns the severity of each channel.
+ getCompressedDataSize
+ Returns the name of each channel.
+ getUncompressedDataSize
+ Returns connection state of each channel.
+ getAttribute
+ Returns the status of each channel.
+ getDimension
+ Returns the message of each channel.
+ getUniqueId
+ Returns the secondsPastEpoch of each channel.
+ getDataTimeStamp
+ Returns the data timeStamp.
+
getDescriptor
Get the descriptor.
getTimeStamp
@@ -1459,20 +1482,6 @@ where
If the display was not selected as an optional field
a null pvStructure is returned.
- getValue
- Returns the value field.
- getCompressedDataSize
- Returns the name of each channel.
- getUncompressedDataSize
- Returns connection state of each channel.
- getCodec
- Returns the severity of each channel.
- getAttribute
- Returns the status of each channel.
- getDimension
- Returns the message of each channel.
- getUniqueId
- Returns the secondsPastEpoch of each channel.
diff --git a/src/nt/ntmultiChannel.cpp b/src/nt/ntmultiChannel.cpp
index f9c6124..0fc53e2 100644
--- a/src/nt/ntmultiChannel.cpp
+++ b/src/nt/ntmultiChannel.cpp
@@ -195,7 +195,7 @@ NTMultiChannelBuilder::shared_pointer NTMultiChannelBuilder::add(string const &
}
-const std::string NTMultiChannel::URI("ev4:nt/NTMultiChannel:1.0");
+const std::string NTMultiChannel::URI("epics:nt/NTMultiChannel:1.0");
NTMultiChannel::shared_pointer NTMultiChannel::wrap(PVStructurePtr const & structure)
{
diff --git a/src/nt/ntnameValue.cpp b/src/nt/ntnameValue.cpp
index b1dd26a..e80b558 100644
--- a/src/nt/ntnameValue.cpp
+++ b/src/nt/ntnameValue.cpp
@@ -108,7 +108,7 @@ NTNameValueBuilder::shared_pointer NTNameValueBuilder::add(string const & name,
}
-const std::string NTNameValue::URI("ev4:nt/NTNameValue:1.0");
+const std::string NTNameValue::URI("epics:nt/NTNameValue:1.0");
NTNameValue::shared_pointer NTNameValue::wrap(PVStructurePtr const & structure)
{
diff --git a/src/nt/ntndarray.cpp b/src/nt/ntndarray.cpp
index 1635dc5..14b5016 100644
--- a/src/nt/ntndarray.cpp
+++ b/src/nt/ntndarray.cpp
@@ -18,7 +18,7 @@ static NTFieldPtr ntField = NTField::get();
namespace detail {
-const std::string ntAttrStr("ev4:nt/NTAttribute:1.0");
+const std::string ntAttrStr("epics:nt/NTAttribute:1.0");
static FieldCreatePtr fieldCreate = getFieldCreate();
static PVDataCreatePtr pvDataCreate = getPVDataCreate();
@@ -198,8 +198,8 @@ NTNDArrayBuilder::shared_pointer NTNDArrayBuilder::add(string const & name, Fiel
}
-const std::string NTNDArray::URI("ev4:nt/NTNDArray:1.0");
-const std::string ntAttrStr("ev4:nt/NTAttribute:1.0");
+const std::string NTNDArray::URI("epics:nt/NTNDArray:1.0");
+const std::string ntAttrStr("epics:nt/NTAttribute:1.0");
static FieldCreatePtr fieldCreate = getFieldCreate();
static PVDataCreatePtr pvDataCreate = getPVDataCreate();
@@ -245,7 +245,7 @@ bool NTNDArray::isCompatible(PVStructurePtr const & pvStructure)
pvField = pvStructure->getSubField("dataTimeStamp");
if(pvField && !ntField->isTimeStamp(pvField->getField())) return false;
PVStructureArrayPtr pvAttribute = pvStructure->getSubField("attribute");
- if(!pvAttribute->getStructureArray()->getStructure()->getID().compare("ntAttrStr")!=0) return false;
+ if(pvAttribute->getStructureArray()->getStructure()->getID().compare(ntAttrStr)!=0) return false;
return true;
}
diff --git a/src/nt/ntscalar.cpp b/src/nt/ntscalar.cpp
index 3b3c660..e28b729 100644
--- a/src/nt/ntscalar.cpp
+++ b/src/nt/ntscalar.cpp
@@ -128,7 +128,7 @@ NTScalarBuilder::shared_pointer NTScalarBuilder::add(string const & name, FieldC
}
-const std::string NTScalar::URI("ev4:nt/NTScalar:1.0");
+const std::string NTScalar::URI("epics:nt/NTScalar:1.0");
NTScalar::shared_pointer NTScalar::wrap(PVStructurePtr const & structure)
{
diff --git a/src/nt/ntscalarArray.cpp b/src/nt/ntscalarArray.cpp
index 511c2b0..6e6addf 100644
--- a/src/nt/ntscalarArray.cpp
+++ b/src/nt/ntscalarArray.cpp
@@ -125,7 +125,7 @@ NTScalarArrayBuilder::shared_pointer NTScalarArrayBuilder::add(string const & na
}
-const std::string NTScalarArray::URI("ev4:nt/NTScalarArray:1.0");
+const std::string NTScalarArray::URI("epics:nt/NTScalarArray:1.0");
NTScalarArray::shared_pointer NTScalarArray::wrap(PVStructurePtr const & structure)
{
diff --git a/src/nt/nttable.cpp b/src/nt/nttable.cpp
index 207f462..dc96906 100644
--- a/src/nt/nttable.cpp
+++ b/src/nt/nttable.cpp
@@ -123,7 +123,7 @@ NTTableBuilder::shared_pointer NTTableBuilder::add(string const & name, FieldCon
}
-const std::string NTTable::URI("ev4:nt/NTTable:1.0");
+const std::string NTTable::URI("epics:nt/NTTable:1.0");
NTTable::shared_pointer NTTable::wrap(PVStructurePtr const & structure)
{