Correct spelling and typos in doxygen and comments
Signed-off-by: Dave Hickin <david.hickin@diamond.ac.uk>
This commit is contained in:
+11
-11
@@ -66,8 +66,8 @@ public:
|
||||
POINTER_DEFINITIONS(PVCopy);
|
||||
/**
|
||||
* Create a new pvCopy
|
||||
* @param pvMaster The top level sructure for which a copy of
|
||||
* an arbritary subset of the fields in master will be created and managed.
|
||||
* @param pvMaster The top-level structure for which a copy of
|
||||
* an arbitrary subset of the fields in master will be created and managed.
|
||||
* @param pvRequest Selects the set of subfields desired and options for each field.
|
||||
* @param structureName The name for the top level of any PVStructure created.
|
||||
*/
|
||||
@@ -78,8 +78,8 @@ public:
|
||||
virtual ~PVCopy(){}
|
||||
virtual void destroy();
|
||||
/**
|
||||
* Get the top level structure of master
|
||||
* @returns The master top level structure.
|
||||
* Get the top-level structure of master
|
||||
* @returns The master top-level structure.
|
||||
* This should not be modified.
|
||||
*/
|
||||
PVStructurePtr getPVMaster();
|
||||
@@ -97,7 +97,7 @@ public:
|
||||
StructureConstPtr getStructure();
|
||||
/**
|
||||
* Create a copy instance. Monitors keep a queue of monitor elements.
|
||||
* Since each element needs a PVStructure, multiple top level structures will be created.
|
||||
* Since each element needs a PVStructure, multiple top-level structures will be created.
|
||||
*/
|
||||
PVStructurePtr createPVStructure();
|
||||
/**
|
||||
@@ -124,7 +124,7 @@ public:
|
||||
* Initialize the fields in copyPVStructure by giving each field
|
||||
* the value from the corresponding field in pvMaster.
|
||||
* bitSet will be set to show that all fields are changed.
|
||||
* @param copyPVStructure A copy top level structure.
|
||||
* @param copyPVStructure A copy top-level structure.
|
||||
* @param bitSet A bitSet for copyPVStructure.
|
||||
*/
|
||||
void initCopy(
|
||||
@@ -133,7 +133,7 @@ public:
|
||||
/**
|
||||
* Set all fields in copyPVStructure to the value of the corresponding field in pvMaster.
|
||||
* Each field that is changed has it's corresponding bit set in bitSet.
|
||||
* @param copyPVStructure A copy top level structure.
|
||||
* @param copyPVStructure A copy top-level structure.
|
||||
* @param bitSet A bitSet for copyPVStructure.
|
||||
*/
|
||||
void updateCopySetBitSet(
|
||||
@@ -141,8 +141,8 @@ public:
|
||||
BitSetPtr const &bitSet);
|
||||
/**
|
||||
* For each set bit in bitSet
|
||||
* set the field in copyPVStructure to the value of the corrseponding field in pvMaster.
|
||||
* @param copyPVStructure A copy top level structure.
|
||||
* set the field in copyPVStructure to the value of the corresponding field in pvMaster.
|
||||
* @param copyPVStructure A copy top-level structure.
|
||||
* @param bitSet A bitSet for copyPVStructure.
|
||||
*/
|
||||
void updateCopyFromBitSet(
|
||||
@@ -150,8 +150,8 @@ public:
|
||||
BitSetPtr const &bitSet);
|
||||
/**
|
||||
* For each set bit in bitSet
|
||||
* set the field in pvMaster to the value of the corrseponding field in copyPVStructure
|
||||
* @param copyPVStructure A copy top level structure.
|
||||
* set the field in pvMaster to the value of the corresponding field in copyPVStructure
|
||||
* @param copyPVStructure A copy top-level structure.
|
||||
* @param bitSet A bitSet for copyPVStructure.
|
||||
*/
|
||||
void updateMaster(
|
||||
|
||||
@@ -18,7 +18,7 @@ using std::string;
|
||||
|
||||
namespace epics { namespace pvData {
|
||||
|
||||
// Introspection object comparision
|
||||
// Introspection object comparison
|
||||
|
||||
/** Field equality conditions:
|
||||
* 1) same instance
|
||||
|
||||
@@ -554,7 +554,7 @@ StructureConstPtr StandardField::enumerated()
|
||||
fields[0] = fieldCreate->createScalar(pvInt);
|
||||
fields[1] = fieldCreate->createScalarArray(pvString);
|
||||
return fieldCreate->createStructure("enum_t",names,fields);
|
||||
// NOTE: if this method is used to get NTEnum wihtout properties the ID will be wrong!
|
||||
// NOTE: if this method is used to get NTEnum without properties the ID will be wrong!
|
||||
}
|
||||
|
||||
StructureConstPtr StandardField::enumerated(string const &properties)
|
||||
|
||||
+1
-1
@@ -208,7 +208,7 @@ namespace epics { namespace pvData {
|
||||
BitSet& operator^=(const BitSet& set);
|
||||
|
||||
/**
|
||||
* Assigment operator.
|
||||
* Assignment operator.
|
||||
*/
|
||||
BitSet& operator=(const BitSet &set);
|
||||
|
||||
|
||||
@@ -714,7 +714,7 @@ private:
|
||||
}
|
||||
else
|
||||
{
|
||||
// NOTE: this check and branching does not always payoff
|
||||
// NOTE: this check and branching does not always pay off
|
||||
if (ADAPTIVE_ACCESS && is_aligned(_position, sizeof(T)))
|
||||
{
|
||||
*((T*)_position) = value;
|
||||
@@ -757,12 +757,12 @@ private:
|
||||
|
||||
if (UNALIGNED_ACCESS)
|
||||
{
|
||||
// NOTE: some CPU handle unaligned access preety good (e.g. x86)
|
||||
// NOTE: some CPU handle unaligned access pretty good (e.g. x86)
|
||||
*((T*)(_buffer + index)) = value;
|
||||
}
|
||||
else
|
||||
{
|
||||
// NOTE: this check and branching does not always payoff
|
||||
// NOTE: this check and branching does not always pay off
|
||||
if (ADAPTIVE_ACCESS && is_aligned(_position, sizeof(T)))
|
||||
{
|
||||
*((T*)(_buffer + index)) = value;
|
||||
@@ -805,13 +805,13 @@ private:
|
||||
|
||||
if (UNALIGNED_ACCESS)
|
||||
{
|
||||
// NOTE: some CPU handle unaligned access preety good (e.g. x86)
|
||||
// NOTE: some CPU handle unaligned access pretty good (e.g. x86)
|
||||
value = *((T*)_position);
|
||||
_position += sizeof(T);
|
||||
}
|
||||
else
|
||||
{
|
||||
// NOTE: this check and branching does not always payoff
|
||||
// NOTE: this check and branching does not always pay off
|
||||
if (ADAPTIVE_ACCESS && is_aligned(_position, sizeof(T)))
|
||||
{
|
||||
value = *((T*)_position);
|
||||
@@ -857,12 +857,12 @@ private:
|
||||
|
||||
if (UNALIGNED_ACCESS)
|
||||
{
|
||||
// NOTE: some CPU handle unaligned access preety good (e.g. x86)
|
||||
// NOTE: some CPU handle unaligned access pretty good (e.g. x86)
|
||||
value = *((T*)(_buffer + index));
|
||||
}
|
||||
else
|
||||
{
|
||||
// NOTE: this check and branching does not always payoff
|
||||
// NOTE: this check and branching does not always pay off
|
||||
if (ADAPTIVE_ACCESS && is_aligned(_position, sizeof(T)))
|
||||
{
|
||||
value = *((T*)(_buffer + index));
|
||||
@@ -909,7 +909,7 @@ private:
|
||||
memcpy(_position, values, n);
|
||||
_position += n;
|
||||
|
||||
// ... so that we can be fast changing endianess
|
||||
// ... so that we can be fast changing endianness
|
||||
if (ENDIANESS_SUPPORT && reverse<T>())
|
||||
{
|
||||
for (std::size_t i = 0; i < count; i++)
|
||||
@@ -937,7 +937,7 @@ private:
|
||||
memcpy(values, _position, n);
|
||||
_position += n;
|
||||
|
||||
// ... so that we can be fast changing endianess
|
||||
// ... so that we can be fast changing endianness
|
||||
if (ENDIANESS_SUPPORT && reverse<T>())
|
||||
{
|
||||
for (std::size_t i = 0; i < count; i++)
|
||||
|
||||
@@ -33,7 +33,7 @@ protected:
|
||||
*/
|
||||
~NoDefaultMethods(){}
|
||||
private:
|
||||
// do not implment
|
||||
// do not implement
|
||||
NoDefaultMethods(const NoDefaultMethods&);
|
||||
NoDefaultMethods & operator=(const NoDefaultMethods &);
|
||||
};
|
||||
|
||||
@@ -48,7 +48,7 @@ namespace epics { namespace pvData {
|
||||
virtual void ensureBuffer(std::size_t size) =0;
|
||||
/**
|
||||
* Add pad bytes to buffer.
|
||||
* @param alignment allignment required.
|
||||
* @param alignment alignment required.
|
||||
*/
|
||||
virtual void alignBuffer(std::size_t alignment) =0;
|
||||
/**
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
* serializeHelper.cpp
|
||||
*
|
||||
* Created on: Oct 22, 2010
|
||||
* Author: Miha vitorovic
|
||||
* Author: Miha Vitorovic
|
||||
*/
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
@@ -230,7 +230,7 @@ namespace detail {
|
||||
};
|
||||
}
|
||||
|
||||
/** @brief A holder for a contigious piece of memory.
|
||||
/** @brief A holder for a contiguous piece of memory.
|
||||
*
|
||||
* Data is shared, but offset and length are not.
|
||||
* This allows one vector to have access to only a
|
||||
@@ -427,7 +427,7 @@ public:
|
||||
* owner of the data array.
|
||||
*
|
||||
* If a copy is needed, memory is allocated with new[]. If this is
|
||||
* not desireable then do something like the following.
|
||||
* not desirable then do something like the following.
|
||||
@code
|
||||
shared_vector<E> original(...);
|
||||
|
||||
@@ -864,7 +864,7 @@ std::ostream& operator<<(std::ostream& strm, const epics::pvData::shared_vector<
|
||||
* The copy constructor and assignment operator allow implicit
|
||||
* casting from type 'shared_vector<T>' to 'shared_vector<const T>'.
|
||||
*
|
||||
* To faciliate safe modification the methods unique() and
|
||||
* To facilitate safe modification the methods unique() and
|
||||
* make_unique() are provided.
|
||||
*
|
||||
* The slice() method selects a sub-set of the shared_vector.
|
||||
|
||||
+2
-2
@@ -71,7 +71,7 @@ class epicsShareClass Timer : public Runnable {
|
||||
public:
|
||||
POINTER_DEFINITIONS(Timer);
|
||||
/**
|
||||
* Contructor
|
||||
* Constructor
|
||||
* @param threadName name for the timer thread.
|
||||
* @param priority thread priority
|
||||
*/
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
*/
|
||||
virtual ~Timer();
|
||||
/**
|
||||
* The thead run method. This is called automatically.
|
||||
* The thread run method. This is called automatically.
|
||||
*/
|
||||
virtual void run();
|
||||
/**
|
||||
|
||||
+2
-2
@@ -59,7 +59,7 @@ namespace detail {
|
||||
typedef T return_t;
|
||||
static FORCE_INLINE return_t op(const T& i) { return i; }
|
||||
};
|
||||
// trick std::ostream into treating char's as numbers
|
||||
// trick std::ostream into treating chars as numbers
|
||||
// by promoting char to int
|
||||
template<>
|
||||
struct print_convolute<int8> {
|
||||
@@ -142,7 +142,7 @@ namespace detail {
|
||||
* - float -> double
|
||||
*
|
||||
* Conversions where out of range inputs always produce
|
||||
* a defined result, but may not be reversable.
|
||||
* a defined result, but may not be reversible.
|
||||
*
|
||||
* - double -> float. When abs(value) is outside the range
|
||||
* [FLT_MIN, FLT_MAX] the value is clipped to FLT_MIN or FLT_MAX
|
||||
|
||||
@@ -38,7 +38,7 @@ typedef std::tr1::shared_ptr<MonitorPluginManager> MonitorPluginManagerPtr;
|
||||
* This is for use by pvAccess servers that support monitors.
|
||||
* Since the interface has only a dependence on pvData it
|
||||
* can be used for other purposes.
|
||||
* A monitor is assumed to be associated with a field of a top level
|
||||
* A monitor is assumed to be associated with a field of a top-level
|
||||
* structure.
|
||||
*/
|
||||
class epicsShareClass MonitorPlugin
|
||||
@@ -53,8 +53,8 @@ public:
|
||||
/**
|
||||
* Should a monitor be raised?
|
||||
* @param pvField The field being monitored.
|
||||
* @param pvTop The top level sructure in which the field resides.
|
||||
* @param monitorElement The client data and bitSets.
|
||||
* @param pvTop The top-level structure in which the field resides.
|
||||
* @param monitorElement The client data and bitsets.
|
||||
* @returns true or false.
|
||||
* True is returned if the change to this field should cause a monitor.
|
||||
* False is returned in a change only to this field should not cause a
|
||||
@@ -68,7 +68,7 @@ public:
|
||||
* A monitor will be sent to the client.
|
||||
* @param pvField The copy of the field being monitored.
|
||||
* The plugin can modify the data.
|
||||
* @param pvTop The top level sructure in which the field resides.
|
||||
* @param pvTop The top-level structure in which the field resides.
|
||||
* @param monitorElement The data for the client.
|
||||
* The plugin is allowed to change the data values.
|
||||
*/
|
||||
@@ -105,7 +105,7 @@ public:
|
||||
/**
|
||||
* Create a monitor plugin.
|
||||
* @param field The introspection interface for the field monitored.
|
||||
* @param top The introspsction interface for the client structure.
|
||||
* @param top The introspection interface for the client structure.
|
||||
* @param pvFieldOptions The options the client requested.
|
||||
* The structure has a set of PVString subfields.
|
||||
* The options are a set of name,value pairs.
|
||||
|
||||
@@ -76,7 +76,7 @@ public:
|
||||
/**
|
||||
* copy the values from Alarm to the alarm structure.
|
||||
* @param alarm An instance of class Alarm
|
||||
* @return (false,true) if pvField (immutable, muttable)
|
||||
* @return (false,true) if pvField (immutable, mutable)
|
||||
* @throw If not attached to a pvField.
|
||||
*/
|
||||
bool set(Alarm const & alarm);
|
||||
|
||||
@@ -68,7 +68,7 @@ public:
|
||||
/**
|
||||
* copy the values from Control to the control structure.
|
||||
* @param control An instance of class Control
|
||||
* @return (false,true) if pvField (immutable, muttable)
|
||||
* @return (false,true) if pvField (immutable, mutable)
|
||||
* @throw If not attached to a pvField.
|
||||
*/
|
||||
bool set(Control const & control);
|
||||
|
||||
@@ -72,7 +72,7 @@ public:
|
||||
/**
|
||||
* copy the values from Display to the display structure.
|
||||
* @param display An instance of class Display
|
||||
* @return (false,true) if pvField (immutable, muttable)
|
||||
* @return (false,true) if pvField (immutable, mutable)
|
||||
* @throw If not attached to a pvField.
|
||||
*/
|
||||
bool set(Display const & display);
|
||||
|
||||
@@ -98,7 +98,7 @@ public:
|
||||
int32 getNumberChoices();
|
||||
/**
|
||||
* Get the choices.
|
||||
* @param choics The new value for choices.`
|
||||
* @param choices The new value for choices.`
|
||||
* @return (false,true) if choices (was not was) replaced.
|
||||
* @throw if not attached.
|
||||
*/
|
||||
|
||||
@@ -73,7 +73,7 @@ public:
|
||||
/**
|
||||
* copy the values from TimeStamp to the timeStamp structure.
|
||||
* @param timeStamp An instance of class TimeStamp
|
||||
* @return (false,true) if pvField (immutable, muttable)
|
||||
* @return (false,true) if pvField (immutable, mutable)
|
||||
* @throw If not attached to a pvField.
|
||||
*/
|
||||
bool set(TimeStamp const & timeStamp);
|
||||
|
||||
@@ -97,7 +97,7 @@ public:
|
||||
}
|
||||
/**
|
||||
* Get nanoseconds.
|
||||
* @return nanoseconds withing timeStamp.
|
||||
* @return nanoseconds within timeStamp.
|
||||
*/
|
||||
int32 getNanoseconds() const {return nanoseconds;}
|
||||
/**
|
||||
|
||||
+38
-38
@@ -142,7 +142,7 @@ public:
|
||||
*/
|
||||
virtual ~PostHandler(){}
|
||||
/**
|
||||
* This is called evertime postPut is called for this field.
|
||||
* This is called every time postPut is called for this field.
|
||||
*/
|
||||
virtual void postPut() = 0;
|
||||
};
|
||||
@@ -168,19 +168,19 @@ public:
|
||||
virtual ~PVField();
|
||||
/**
|
||||
* Get the fieldName for this field.
|
||||
* @return The name or empty string if top level field.
|
||||
* @return The name or empty string if top-level field.
|
||||
*/
|
||||
inline const std::string& getFieldName() const {return fieldName;}
|
||||
/**
|
||||
* Fully expand the name of this field using the
|
||||
* names of its parent fields with a dot '.' seperating
|
||||
* names of its parent fields with a dot '.' separating
|
||||
* each name.
|
||||
*/
|
||||
std::string getFullName() const;
|
||||
/**
|
||||
* Get offset of the PVField field within top level structure.
|
||||
* Get offset of the PVField field within top-level structure.
|
||||
* Every field within the PVStructure has a unique offset.
|
||||
* The top level structure has an offset of 0.
|
||||
* The top-level structure has an offset of 0.
|
||||
* The first field within the structure has offset equal to 1.
|
||||
* The other offsets are determined by recursively traversing each structure of the tree.
|
||||
* @return The offset.
|
||||
@@ -204,8 +204,8 @@ public:
|
||||
*/
|
||||
bool isImmutable() const;
|
||||
/**
|
||||
* Set the field to be immutable, i. e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field can onot be made mutable.
|
||||
* Set the field to be immutable, i.e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field cannot be made mutable.
|
||||
*/
|
||||
virtual void setImmutable();
|
||||
/**
|
||||
@@ -339,7 +339,7 @@ protected:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Class that holds the data for each posssible scalar type.
|
||||
* @brief Class that holds the data for each possible scalar type.
|
||||
*
|
||||
*/
|
||||
template<typename T>
|
||||
@@ -504,8 +504,8 @@ public:
|
||||
*/
|
||||
virtual ArrayConstPtr getArray() const = 0;
|
||||
/**
|
||||
* Set the field to be immutable, i. e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field can onot be made mutable.
|
||||
* Set the field to be immutable, i.e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field cannot be made mutable.
|
||||
*/
|
||||
virtual void setImmutable();
|
||||
/**
|
||||
@@ -602,7 +602,7 @@ public:
|
||||
* A copy and element-wise conversion is performed unless
|
||||
* the element type of the PVScalarArray matches the
|
||||
* type of the provided data.
|
||||
* If the types do match then a new refernce to the provided
|
||||
* If the types do match then a new reference to the provided
|
||||
* data is kept.
|
||||
*
|
||||
* Calls postPut()
|
||||
@@ -620,7 +620,7 @@ public:
|
||||
* A copy and element-wise conversion is performed unless
|
||||
* the element type of the PVScalarArray matches the
|
||||
* type of the provided data.
|
||||
* If the types do match then a new refernce to the provided
|
||||
* If the types do match then a new reference to the provided
|
||||
* data is kept.
|
||||
*/
|
||||
void assign(const PVScalarArray& pv) {
|
||||
@@ -663,8 +663,8 @@ public:
|
||||
typedef PVStructure & reference;
|
||||
typedef const PVStructure & const_reference;
|
||||
/**
|
||||
* Set the field to be immutable, i. e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field can onot be made mutable.
|
||||
* Set the field to be immutable, i.e. it can no longer be modified.
|
||||
* This is permanent, i.e. once done the field cannot be made mutable.
|
||||
*/
|
||||
virtual void setImmutable();
|
||||
/**
|
||||
@@ -717,7 +717,7 @@ public:
|
||||
|
||||
/**
|
||||
* Get a subfield with the specified name.
|
||||
* @param name a '.' seperated list of child field names (no whitespace allowed)
|
||||
* @param name a '.' separated list of child field names (no whitespace allowed)
|
||||
* @returns A reference to the sub-field (never NULL)
|
||||
* @throws std::runtime_error if the requested sub-field doesn't exist, or has a different type
|
||||
* @code
|
||||
@@ -741,84 +741,84 @@ public:
|
||||
|
||||
/**
|
||||
* Get a boolean field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVBooleanPtr getBooleanField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a byte field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVBytePtr getByteField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a short field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVShortPtr getShortField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a int field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVIntPtr getIntField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a long field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVLongPtr getLongField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get an unsigned byte field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVUBytePtr getUByteField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get an unsigned short field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVUShortPtr getUShortField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get an unsigned int field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVUIntPtr getUIntField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get an unsigned long field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVULongPtr getULongField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a float field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVFloatPtr getFloatField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a double field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVDoublePtr getDoubleField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a string field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
@@ -826,21 +826,21 @@ public:
|
||||
|
||||
/**
|
||||
* Get a structure field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVStructurePtr getStructureField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a union field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVUnionPtr getUnionField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a scalarArray field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @param elementType The element type.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
@@ -849,14 +849,14 @@ public:
|
||||
std::string const &fieldName,ScalarType elementType);
|
||||
/**
|
||||
* Get a structureArray field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
PVStructureArrayPtr getStructureArrayField(std::string const &fieldName) USAGE_DEPRECATED;
|
||||
/**
|
||||
* Get a unionArray field with the specified name.
|
||||
* @deprecated No longer needed. Use templete version of getSubField
|
||||
* @deprecated No longer needed. Use template version of getSubField
|
||||
* @param fieldName The name of the field to get.
|
||||
* @return Pointer to the field of null if a field with that name and type does not exist.
|
||||
*/
|
||||
@@ -1111,7 +1111,7 @@ namespace detail {
|
||||
public:
|
||||
virtual ~PVVectorStorage(){};
|
||||
|
||||
// Primative array manipulations
|
||||
// Primitive array manipulations
|
||||
|
||||
//! Fetch a read-only view of the current array data
|
||||
virtual const_svector view() const = 0;
|
||||
@@ -1466,7 +1466,7 @@ typedef PVValueArray<std::string> PVStringArray;
|
||||
typedef std::tr1::shared_ptr<PVStringArray> PVStringArrayPtr;
|
||||
|
||||
/**
|
||||
* @brief This is a singlton class for creating data instances.
|
||||
* @brief This is a singleton class for creating data instances.
|
||||
*
|
||||
*/
|
||||
class epicsShareClass PVDataCreate {
|
||||
@@ -1511,7 +1511,7 @@ public:
|
||||
PVScalarPtr createPVScalar(PVScalarPtr const & scalarToClone);
|
||||
/**
|
||||
* template version
|
||||
* @param PVT must ve a valid pvType
|
||||
* @param PVT must be a valid pvType
|
||||
* @return The PVScalar implementation.
|
||||
*/
|
||||
template<typename PVT>
|
||||
@@ -1581,7 +1581,7 @@ public:
|
||||
PVScalarArrayPtr createPVScalarArray(PVScalarArrayPtr const & scalarArrayToClone);
|
||||
/**
|
||||
* template version
|
||||
* @param PVT must ve a valid pvType
|
||||
* @param PVT must be a valid pvType
|
||||
* @return The PVScalarArray implementation.
|
||||
*/
|
||||
template<typename PVAT>
|
||||
@@ -1617,7 +1617,7 @@ public:
|
||||
PVUnionArrayPtr createPVUnionArray(UnionArrayConstPtr const & unionArray);
|
||||
/**
|
||||
* Create an implementation of an array with union elements.
|
||||
* @param punion The introspection interface tht is used to create UnionArrayConstPtr.
|
||||
* @param punion The introspection interface that is used to create UnionArrayConstPtr.
|
||||
* All elements share the same introspection interface.
|
||||
* @return The PVUnionArray implementation.
|
||||
*/
|
||||
@@ -1637,7 +1637,7 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the single class that implemnents PVDataCreate
|
||||
* Get the single class that implements PVDataCreate
|
||||
* @param The PVDataCreate factory.
|
||||
*/
|
||||
|
||||
|
||||
+17
-17
@@ -183,51 +183,51 @@ epicsShareExtern std::ostream& operator<<(std::ostream& o, const Type& type);
|
||||
*/
|
||||
enum ScalarType {
|
||||
/**
|
||||
* The type is boolean, i. e. value can be {@code false} or {@code true}
|
||||
* The type is boolean, i.e. value can be {@code false} or {@code true}
|
||||
*/
|
||||
pvBoolean,
|
||||
/**
|
||||
* The type is byte, i. e. a 8 bit signed integer.
|
||||
* The type is byte, i.e. a 8 bit signed integer.
|
||||
*/
|
||||
pvByte,
|
||||
/**
|
||||
* The type is short, i. e. a 16 bit signed integer.
|
||||
* The type is short, i.e. a 16 bit signed integer.
|
||||
*/
|
||||
pvShort,
|
||||
/**
|
||||
* The type is int, i. e. a 32 bit signed integer.
|
||||
* The type is int, i.e. a 32 bit signed integer.
|
||||
*/
|
||||
pvInt,
|
||||
/**
|
||||
* The type is long, i. e. a 64 bit signed integer.
|
||||
* The type is long, i.e. a 64 bit signed integer.
|
||||
*/
|
||||
pvLong,
|
||||
/**
|
||||
* The type is unsigned byte, i. e. a 8 bit unsigned integer.
|
||||
* The type is unsigned byte, i.e. a 8 bit unsigned integer.
|
||||
*/
|
||||
pvUByte,
|
||||
/**
|
||||
* The type is unsigned short, i. e. a 16 bit unsigned integer.
|
||||
* The type is unsigned short, i.e. a 16 bit unsigned integer.
|
||||
*/
|
||||
pvUShort,
|
||||
/**
|
||||
* The type is unsigned int, i. e. a 32 bit unsigned integer.
|
||||
* The type is unsigned int, i.e. a 32 bit unsigned integer.
|
||||
*/
|
||||
pvUInt,
|
||||
/**
|
||||
* The type is unsigned long, i. e. a 64 bit unsigned integer.
|
||||
* The type is unsigned long, i.e. a 64 bit unsigned integer.
|
||||
*/
|
||||
pvULong,
|
||||
/**
|
||||
* The type is float, i. e. 32 bit IEEE floating point,
|
||||
* The type is float, i.e. 32 bit IEEE floating point,
|
||||
*/
|
||||
pvFloat,
|
||||
/**
|
||||
* The type is float, i. e. 64 bit IEEE floating point,
|
||||
* The type is float, i.e. 64 bit IEEE floating point,
|
||||
*/
|
||||
pvDouble,
|
||||
/**
|
||||
* The type is string, i. e. a UTF8 character string.
|
||||
* The type is string, i.e. a UTF8 character string.
|
||||
*/
|
||||
pvString
|
||||
};
|
||||
@@ -240,25 +240,25 @@ enum ScalarType {
|
||||
*/
|
||||
namespace ScalarTypeFunc {
|
||||
/**
|
||||
* Is the type an integer, i. e. is it one of byte,...ulong
|
||||
* Is the type an integer, i.e. is it one of byte,...ulong
|
||||
* @param scalarType The type.
|
||||
* @return (false,true) if the scalarType is an integer.
|
||||
*/
|
||||
epicsShareExtern bool isInteger(ScalarType scalarType);
|
||||
/**
|
||||
* Is the type an unsigned integer, i. e. is it one of ubyte,...ulong
|
||||
* Is the type an unsigned integer, i.e. is it one of ubyte,...ulong
|
||||
* @param scalarType The type.
|
||||
* @return (false,true) if the scalarType is an integer.
|
||||
*/
|
||||
epicsShareExtern bool isUInteger(ScalarType scalarType);
|
||||
/**
|
||||
* Is the type numeric, i. e. is it one of byte,...,double
|
||||
* Is the type numeric, i.e. is it one of byte,...,double
|
||||
* @param scalarType The type.
|
||||
* @return (false,true) if the scalarType is a numeric
|
||||
*/
|
||||
epicsShareExtern bool isNumeric(ScalarType scalarType);
|
||||
/**
|
||||
* Is the type primitive, i. e. not string
|
||||
* Is the type primitive, i.e. not string
|
||||
* @param scalarType The type.
|
||||
* @return (false,true) if the scalarType is primitive.
|
||||
*/
|
||||
@@ -1200,7 +1200,7 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the single class that implemnents FieldCreate,
|
||||
* Get the single class that implements FieldCreate,
|
||||
* @param The fieldCreate factory.
|
||||
*/
|
||||
epicsShareExtern FieldCreatePtr getFieldCreate();
|
||||
|
||||
+1
-1
@@ -49,7 +49,7 @@ namespace detail {
|
||||
}
|
||||
|
||||
/**
|
||||
* This is a set of typdefs used by pvData.
|
||||
* This is a set of typedefs used by pvData.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -86,7 +86,7 @@ public:
|
||||
StructureConstPtr regUnion(
|
||||
UnionConstPtr const & punion,
|
||||
std::string const & properties);
|
||||
/** Create a structure that has a varient union value field.
|
||||
/** Create a structure that has a variant union value field.
|
||||
* @param properties A comma separated list of properties.
|
||||
* This is some combination of "alarm,timeStamp,display,control,valueAlarm".
|
||||
* @return The const shared pointer to the structure.
|
||||
|
||||
@@ -497,8 +497,8 @@ static void testICE()
|
||||
|
||||
D = B; // create second const reference
|
||||
|
||||
// clears D, but reference to B refrence
|
||||
// to B remains, so a copy is made
|
||||
// clears D, but reference to B
|
||||
// remains, so a copy is made
|
||||
C = epics::pvData::thaw(D);
|
||||
|
||||
testOk1(B.unique());
|
||||
|
||||
@@ -554,13 +554,13 @@ static void testFieldAccess()
|
||||
} else
|
||||
testSkip(1, "hello.world doesn't exist?");
|
||||
|
||||
// non-existant
|
||||
// non-existent
|
||||
testOk1(fld->getSubField<PVInt>("invalid").get()==NULL);
|
||||
|
||||
// wrong type
|
||||
testOk1(fld->getSubField<PVDouble>("test").get()==NULL);
|
||||
|
||||
// intermediate struct non existant
|
||||
// intermediate struct non-existent
|
||||
testOk1(fld->getSubField<PVDouble>("helo.world").get()==NULL);
|
||||
|
||||
// empty leaf field name
|
||||
|
||||
@@ -61,7 +61,7 @@ rtems_task Init (rtems_task_argument argument);
|
||||
/*
|
||||
* This should be made BSP dependent, not CPU dependent but I know of no
|
||||
* appropriate conditionals to use.
|
||||
* The new general time support makes including the RTC driverr less important.
|
||||
* The new general time support makes including the RTC driver less important.
|
||||
*/
|
||||
#if !defined(mpc604) && !defined(__mc68040__) && !defined(__mcf5200__) && !defined(mpc7455) && !defined(__arm__) /* don't have RTC code */
|
||||
#define CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
|
||||
|
||||
@@ -45,7 +45,7 @@
|
||||
|
||||
|
||||
/*
|
||||
* This file can be copied to an application source dirctory
|
||||
* This file can be copied to an application source directory
|
||||
* and modified to override the values shown below.
|
||||
*
|
||||
* The following CPP symbols may be passed from the Makefile:
|
||||
@@ -111,7 +111,7 @@
|
||||
#define NETWORK_TASK_PRIORITY 150 /* within EPICS' range */
|
||||
#endif
|
||||
|
||||
/* make publicily available for startup scripts... */
|
||||
/* make publicly available for startup scripts... */
|
||||
const int gesysNetworkTaskPriority = NETWORK_TASK_PRIORITY;
|
||||
|
||||
#ifdef FIXED_IP_ADDR
|
||||
|
||||
Reference in New Issue
Block a user