The main changes since release 4.0 are:
+The following methods have been removed from PVStructure
+ +Use template getSubField instead, e.g. use
+ +getSubField< PVInt >(fieldName)
+in place of
+ +getIntField(fieldName)
+Convert copy methods where moved and replaced with methods on PVField classes, i.e.
+PVField::copy(const PVField& from)
Methods
+PVField::copyUnchecked(const PVField& from)
where added to allow unchecked copies, to gain performance + +
were added to allow unchecked copies, to gain performance where checked are not needed (anymore).
+In addition: - isCompatibleXXX methods were removed in favour of Field::operator==. - equals methods were remove in favour of PVField::operator==. - operator== methods where moved to pvIntrospect.h and pvData.h
+Before this method, depending on types for to and from, -sometimes did a shallow cppy, i. e. just made to shared_ptr for to +sometimes did a shallow copy, i.e. just made to shared_ptr for to share the same data as from. Now it always copies between the subfield of to and from.
-createRequest could cause a SEGFAULT if passed a bad argument. -This has been changed so the it returns a null pvStructure -and provies an error.
+ +PVStructure has a new template member
+ +getSubFieldT(std::string const &fieldName)
+that is like getSubField except that it throws a runtime_error +instead of returning null.
+ +This was mainly used in the implementation of getSubField. With a change to +the latter, findSubField was removed.
+New steam operators are available for Field and PVField. Before to print a Field (or any extension) or a PVField (or any extension) it was necessary to have code like:
- void print(StructureConstPtr struct, PVStructurePtr pv)
+
+ void print(StructureConstPtr struc, PVStructurePtr pv)
{
- if(struct) {
- cout << *struct << endl;
+ if(struc) {
+ cout << *struc << endl;
} else {
cout << "nullptr\n"
}
if(pv) {
- cout << *.struct << endl;
+ cout << *.struc << endl;
} else {
cout << "nullptr\n"
}
}
+
Now it can be done as follows:
- void print(StructureConstPtr struct, PVStructurePtr pv)
+
+ void print(StructureConstPtr struc, PVStructurePtr pv)
{
- cout << struct << endl;
+ cout << struc << endl;
cout << pv << endl;
}
-New method getAs that is like getSubField except that it throws exception
-PVStructure has a new template member getAs(const char *name)
-that is like getSubField except that it throws a runtime_error
-instead of returning null.
+
+New template version of Structure::getField
+
+A new template getField method has been added to Structure
+
+template
+std::tr1::shared_ptr< const FT > getField(std::string const &fieldName) const
+
+Can be used, for example, as follows:
+
+StructurePtr tsStruc = struc->getField<Structure>("timeStamp");
+
+
+Fixes for static initialisation order issues
+
+Certain static builds (in particular Windows builds) of applications using
+pvData had issues due to PVStructure::DEFAULT_ID being used before being initialised. This has been fixed.
+
+CreateRequest change
+
+createRequest could cause a SEGFAULT if passed a bad argument.
+This has been changed so the it returns a null pvStructure
+and provides an error.
+
Release 4.0
+
The main changes since release 3.0.2 are:
+
- array semantics now enforce Copy On Write.
- String no longer defined.
@@ -70,21 +146,31 @@ instead of returning null.
- copy is new.
- monitorPlugin is new.
+
New Semantics for Arrays
+
PVScalarArray, PVStructureArray, and PVUnionArray all enforce COW (Copy On Write) Semantics.
-In order to limit memory usage the storage for raw data is managed via a new shared_vector facility.
+In order to limit memory usage the storage for raw data is managed via a new sharedvector facility.
This allows multiple instances of array data to use the shared raw data.
-COW is implemented via shared_vectors of const data, i. e. data that can not be modified.
+COW is implemented via sharedvectors of const data, i. e. data that can not be modified.
+
String no longer defined
+
This is replaced by std::string.
+
timeStamp and valueAlarm name changes
+
In timeStamp nanoSeconds is changed to nanoseconds.
-In valueAlarm hystersis is changed to hysteresis
+
+In valueAlarm hysteresis is changed to hysteresis
+
toString replaced by stream I/O
+
pvData.h and pvIntrospect no longer defines toString
Instead they have stream support.
pvIntrospect uses method dump and pvData uses dumpValue.
For example:
+
PVDoublePtr pvValue;
String buffer;
pvValue->toString(&buffer);
@@ -93,27 +179,40 @@ For example:
pvValue->getField()->toString(&buffer);
cout << buffer << evdl;
+
is replaced by
+
PVDoublePtr pvValue;
cout << *pvValue << endl
cout << *pvValue->getField() << endl;
+
union is a new basic type.
+
There are two new basic types: union_t and unionArray.
+
A union is like a structure that has a single subfield.
There are two flavors:
+
-- varient union The field can have any type.
+- variant union The field can have any type.
- union The field can any of specified set of types.
+
The field type can be dynamically changed.
-copy
+
+copy
+
This consists of createRequest and pvCopy.
createRequest was moved from pvAccess to here.
pvCopy is moved from pvDatabaseCPP and now depends
-only on pvData, i. e. it no longer has any knowledge of PVRecord.
+only on pvData, i.e. it no longer has any knowledge of PVRecord.
+
monitorPlugin
+
This is for is for use by code that implements pvAccess monitors.
This is prototype and is subject to debate.
+
Release 3.0.2
-This was the starting point for RELEASE_NOTES
\ No newline at end of file
+
+This was the starting point for RELEASE_NOTES
diff --git a/documentation/RELEASE_NOTES.md b/documentation/RELEASE_NOTES.md
index 2076f68..17784b7 100644
--- a/documentation/RELEASE_NOTES.md
+++ b/documentation/RELEASE_NOTES.md
@@ -1,13 +1,39 @@
-Release 4.1 IN DEVELOPMENT
+Release 5.0
===========
The main changes since release 4.0 are:
+* Deprecated getXXXField() methods have been removed from PVStructure
* Convert copy methods and equals operators (re)moved
* Convert::copyUnion now always copies between subfields.
-* CreateRequest prevents a possible SEGFAULT.
-* New stream operators for Field and PVField are provided.
-* New method getSubFieldT that is like getSubField except that it throws exception
+* New method getSubFieldT, like getSubField except it throws an exception
+* findSubField method removed from PVStructure
+* New stream operators for Field and PVField are provided
+* New template versions of Structure::getField
+* Fixes for static initialisation order issues
+* CreateRequest prevents a possible SEGFAULT
+
+
+Deprecated getXXXField methods have been removed from PVStructure
+-------------------------------------------------------------------
+
+The following methods have been removed from PVStructure
+
+* getBooleanField
+* getByteField, getShortField, getIntField, getLongField
+* getUByteField, getUShortField, getUIntField, getULongField
+* getStringField
+* getStructureField, getUnionField
+* getScalarArrayField, getStructureArrayField, getUnionArrayField
+
+Use template getSubField instead, e.g. use
+
+ getSubField< PVInt >(fieldName)
+
+in place of
+
+ getIntField(fieldName)
+
Convert copy methods and equals operators
-----------------------------------------
@@ -21,7 +47,7 @@ Methods
PVField::copyUnchecked(const PVField& from)
-where added to allow unchecked copies, to gain performance
+were added to allow unchecked copies, to gain performance
where checked are not needed (anymore).
In addition:
@@ -29,20 +55,33 @@ In addition:
- equals methods were remove in favour of PVField::operator==.
- operator== methods where moved to pvIntrospect.h and pvData.h
+
Convert::copyUnion
-----------------
Before this method, depending on types for to and from,
-sometimes did a shallow cppy, i. e. just made to shared_ptr for to
+sometimes did a shallow copy, i.e. just made to shared_ptr for to
share the same data as from.
Now it always copies between the subfield of to and from.
-CreateRequest change
+
+New method getSubFieldT, like getSubField except it throws an exception
--------------------
-createRequest could cause a SEGFAULT if passed a bad argument.
-This has been changed so the it returns a null pvStructure
-and provies an error.
+PVStructure has a new template member
+
+ getSubFieldT(std::string const &fieldName)
+
+that is like getSubField except that it throws a runtime_error
+instead of returning null.
+
+
+findSubField method removed from PVStructure
+--------------------------------------------
+
+This was mainly used in the implementation of getSubField. With a change to
+the latter, findSubField was removed.
+
New stream operators
--------------------
@@ -51,15 +90,15 @@ New steam operators are available for Field and PVField.
Before to print a Field (or any extension) or a PVField (or any extension)
it was necessary to have code like:
- void print(StructureConstPtr struct, PVStructurePtr pv)
+ void print(StructureConstPtr struc, PVStructurePtr pv)
{
- if(struct) {
- cout << *struct << endl;
+ if(struc) {
+ cout << *struc << endl;
} else {
cout << "nullptr\n"
}
if(pv) {
- cout << *.struct << endl;
+ cout << *.struc << endl;
} else {
cout << "nullptr\n"
}
@@ -67,18 +106,40 @@ it was necessary to have code like:
Now it can be done as follows:
- void print(StructureConstPtr struct, PVStructurePtr pv)
+ void print(StructureConstPtr struc, PVStructurePtr pv)
{
- cout << struct << endl;
+ cout << struc << endl;
cout << pv << endl;
}
-New method getSubFieldT that is like getSubField except that it throws exception
+
+New template version of Structure::getField
+--------------------------------------------
+
+A new template getField method has been added to Structure
+
+template
+std::tr1::shared_ptr< const FT > getField(std::string const &fieldName) const
+
+Can be used, for example, as follows:
+
+ StructurePtr tsStruc = struc->getField("timeStamp");
+
+
+Fixes for static initialisation order issues
+--------------------------------------------
+
+Certain static builds (in particular Windows builds) of applications using
+pvData had issues due to PVStructure::DEFAULT_ID being used before being initialised. This has been fixed.
+
+
+CreateRequest change
--------------------
-PVStructure has a new template member getSubFieldT(std::string const &fieldName)
-that is like getSubField except that it throws a runtime_error
-instead of returning null.
+createRequest could cause a SEGFAULT if passed a bad argument.
+This has been changed so the it returns a null pvStructure
+and provides an error.
+
Release 4.0
===========
@@ -113,7 +174,7 @@ timeStamp and valueAlarm name changes
In timeStamp nanoSeconds is changed to nanoseconds.
-In valueAlarm hystersis is changed to hysteresis
+In valueAlarm hysteresis is changed to hysteresis
toString replaced by stream I/O
@@ -147,7 +208,7 @@ There are two new basic types: union_t and unionArray.
A union is like a structure that has a single subfield.
There are two flavors:
-* varient union The field can have any type.
+* variant union The field can have any type.
* union The field can any of specified set of types.
The field type can be dynamically changed.
@@ -158,7 +219,7 @@ copy
This consists of createRequest and pvCopy.
createRequest was moved from pvAccess to here.
pvCopy is moved from pvDatabaseCPP and now depends
-only on pvData, i. e. it no longer has any knowledge of PVRecord.
+only on pvData, i.e. it no longer has any knowledge of PVRecord.
monitorPlugin
-------------