epics/pvData
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

fix some typos in pvDataCPP.html

Browse Source
This commit is contained in:
Marty Kraimer
2012-10-01 10:02:09 -04:00
parent a23631a8ca
commit 52dfdace88
2 changed files with 3674 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
documentation/pvDataCPP.html
View File

@@ -37,7 +37,7 @@
<h1>EPICS pvDataCPP</h1>
<!-- Maturity: Working Draft or Request for Comments, or Recommendation, and date. -->
<h2 class="nocount">EPICS v4 Working Group, Working Draft, 27-Sep-2012</h2>
<h2 class="nocount">EPICS v4 Working Group, Working Draft, 01-Oct-2012</h2>
<dl>
<dt>Latest version:</dt>
@@ -46,10 +46,12 @@
</dd>
<dt>This version:</dt>
<dd><a
href="http://epics-pvdata.hg.sourceforge.net/hgweb/epics-pvdata/pvDataCPP/raw-file/tip/documentation/pvDataCPP_20120927.html">pvDataCPP_20120927.html</a>
href="http://epics-pvdata.hg.sourceforge.net/hgweb/epics-pvdata/pvDataCPP/raw-file/tip/documentation/pvDataCPP_20121001.html">pvDataCPP_20121001.html</a>
</dd>
<dt>Previous version:</dt>
<dd>None.</dd>
<dd><a
href="http://epics-pvdata.hg.sourceforge.net/hgweb/epics-pvdata/pvDataCPP/raw-file/tip/documentation/pvDataCPP_20120927.html">pvDataCPP_20120927.html</a>
</dd>
<dt>Editors:</dt>
<dd>Marty Kraimer, BNL</dd>
</dl>
@@ -95,7 +97,7 @@ Control System (EPICS).</a></p>
<h2 class="nocount">Status of this Document</h2>
<p>This is the 27-Sep-2012 version of the Java implementation of pvData.</p>
<p>This is the 01-Oct-2012 version of the C++ implementation of pvData.</p>
<p> The text describes software which is a complete implementation of pvData as
currently planned by the EPICS V4 Working Group. </p> </p>
@@ -541,7 +543,6 @@ public:
ScalarType getScalarType() const {return scalarType;}
virtual void toString(StringBuilder buf) const{toString(buf,0);}
virtual void toString(StringBuilder buf,int indentLevel) const;
virtual void toString(StringBuilder buf,int indentLevel) const;
virtual String getID() const;
virtual void serialize(ByteBuffer *buffer, SerializableControl *control) const;
virtual void deserialize(ByteBuffer *buffer, DeserializableContol *control);
@@ -554,6 +555,7 @@ public:
typedef ScalarArray&amp; reference;
typedef const ScalarArray&amp; const_reference;
ScalarArray(ScalarType scalarType);
ScalarType getElementType() const {return elementType;}
virtual void toString(StringBuilder buf) const{toString(buf,0);}
virtual void toString(StringBuilder buf,int indentLevel) const;
@@ -858,7 +860,7 @@ typedef std::vector&lt;PVStructurePtr&gt; PVStructurePtrArray;
typedef std::vector&lt;PVStructurePtr&gt;::iterator PVStructurePtrArray_iterator;
typedef std::vector&lt;PVStructurePtr&gt;::const_iterator PVStructurePtrArray_const__iterator;
typedef std::tr1::shared_ptr&lt;PVStructureArray&gt; PVStructureArrayPtrPostHandler</pre>
typedef std::tr1::shared_ptr&lt;PostHandler&gt; PostHandlerPtr</pre>
<p>PostHandler is a class that must be implemented by any code that calls
setPostHandler. It's single virtual method. postPut is called whenever
@@ -1263,7 +1265,8 @@ typedef std::tr1::shared_ptr&lt;PVStringArray&gt; PVStringArrayPtr;</pre>
<dd>Put data into the array from a vector holding the raw array.</dd>
<dt>shareData( shared_vector const &amp; value, std::size_t capacity,
std::size_t length)</dt>
<dd>Make the instance share the raw data from value. This is most useful
<dd>Make the instance share the raw data from value.<br />
One use is
for immutable arrays. In this case the caller must set the PVArray to be
immutable. In the PVArray is not immutable then it is the applications
responsibility to coordinate access to the array. Again this violates the
@@ -1274,12 +1277,11 @@ typedef std::tr1::shared_ptr&lt;PVStringArray&gt; PVStringArrayPtr;</pre>
choices. Index is a PVInt that is the index of the currently selected
choice. For many enumerated structures choices is immutable. Allowing the
choices internal String[] to be shared between all the instances of an
enumerated structure saves on storage. Another reason for allowing shared
data is so that an application which processes an array can be separated
into multiple modules that directly access the internal data array of a
PVArray. This can be required for minimizing CPU overhead. In this case
it is the applications responsibility to coordinate access to the
array.</dd>
enumerated structure saves on storage.<br />
Another use for shared data is an application which processes an
array via multiple modules. Each accesses the internal data array of a
PVArray. In this case it is the applications responsibility
to coordinate access to the array.</dd>
<dt>get()</dt>
<dd>Get the raw array.</dd>
<dt>getVector()</dt>
@@ -1391,7 +1393,10 @@ public:
<dt>getSubField(String fieldName)</dt>
<dd>Get a subField of a field. For a PVStructure a non-null result is
returned if fieldName is a field of the PVStructure. The fieldName can be
of the form name.name...</dd>
of the form name.name...
If the field does not exist the a Ptr to a NULL value is returned
without any error message being generated.
</dd>
<dt>getSubField(int fieldOffset)</dt>
<dd>Get the field located a fieldOffset, where fieldOffset is relative to
the top level structure. This returns null if the specified field is not
@@ -1414,7 +1419,10 @@ public:
<dd>Look for fieldName. If found and it has the correct type return the
interface. This and the following methods are convenience methods that
allow a user to get the interface to a subfield without requiring
introspection. fieldName can be of the form name.name...</dd>
introspection. fieldName can be of the form name.name...
If the field does not exist or has the wrong type then
message will be called and a Ptr to NULL is returned.
</dd>
<dt>getByteField</dt>
<dd>Look for fieldName. If found and it has the correct type return the
interface.</dd>
@@ -1523,7 +1531,7 @@ public:
unless all requested elements exist or are null. Note that this deletes
the element and sets the array element to null. It does not change the
array capacity. </dd>
<dt>compres</dt>
<dt>compress</dt>
<dd>This moves all null elements and then changes the array capacity. When
done there are no null elements.</dd>
</dl>
@@ -1889,7 +1897,10 @@ value field has properties alarm, timeStamp, and display.</p>
int severity 0
int status 0
string message
double value
timeStamp_t
long secondsPastEpoch
int nanoSeconds
int userTag
display_t
double limitLow 0.0
double limitHigh 10.0

3646
documentation/pvDataCPP20121001.html Normal file
View File

File diff suppressed because it is too large Load Diff