changes for doxygen
This commit is contained in:
@ -56,7 +56,8 @@ class PVDatabase;
|
||||
typedef std::tr1::shared_ptr<PVDatabase> PVDatabasePtr;
|
||||
|
||||
/**
|
||||
* Base interface for a record.
|
||||
* @brief Base interface for a record.
|
||||
*
|
||||
* @author mrk
|
||||
*/
|
||||
class epicsShareClass PVRecord :
|
||||
@ -235,7 +236,8 @@ private:
|
||||
epicsShareExtern std::ostream& operator<<(std::ostream& o, const PVRecord& record);
|
||||
|
||||
/**
|
||||
* Interface for a field of a record.
|
||||
* @brief Interface for a field of a record.
|
||||
*
|
||||
* One exists for each field of the top level PVStructure.
|
||||
* @author mrk
|
||||
*/
|
||||
@ -330,7 +332,8 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* Interface for a field that is a structure.
|
||||
* @brief Interface for a field that is a structure.
|
||||
*
|
||||
* One exists for each structure field of the top level PVStructure.
|
||||
* @author mrk
|
||||
*/
|
||||
@ -386,7 +389,8 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* An interface that must be implemented by any code that accesses the record.
|
||||
* @brief An interface implemented by code that accesses the record.
|
||||
*
|
||||
* @author mrk
|
||||
*/
|
||||
class epicsShareClass PVRecordClient {
|
||||
@ -404,6 +408,8 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Listener for PVRecord::message.
|
||||
*
|
||||
* An interface that is implemented by code that traps calls to PVRecord::message.
|
||||
* @author mrk
|
||||
*/
|
||||
@ -448,7 +454,8 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* The interface to a database of PVRecords.
|
||||
* @brief The interface for a database of PVRecords.
|
||||
*
|
||||
* @author mrk
|
||||
*/
|
||||
class epicsShareClass PVDatabase {
|
||||
@ -503,3 +510,10 @@ private:
|
||||
}}
|
||||
|
||||
#endif /* PVDATABASE_H */
|
||||
|
||||
/** @page Overview Documentation
|
||||
*
|
||||
* <a href = "pvDatabaseCPP.html">pvDatabase.html</a>
|
||||
*
|
||||
*/
|
||||
|
||||
|
@ -57,7 +57,9 @@ typedef std::tr1::shared_ptr<ChannelLocal> ChannelLocalPtr;
|
||||
|
||||
epicsShareExtern MonitorFactoryPtr getMonitorFactory();
|
||||
|
||||
/** MonitorFactory
|
||||
/**
|
||||
* @brief MonitorFactory
|
||||
*
|
||||
* This class provides a static method to create a monitor for a PVRecord
|
||||
*/
|
||||
class epicsShareClass MonitorFactory
|
||||
@ -99,6 +101,8 @@ private:
|
||||
epicsShareExtern ChannelProviderLocalPtr getChannelProviderLocal();
|
||||
|
||||
/**
|
||||
* @brief ChannelProvider for PVDatabase.
|
||||
*
|
||||
* An implementation of channelProvider that provides access to records in PVDatabase.
|
||||
*/
|
||||
class epicsShareClass ChannelProviderLocal :
|
||||
@ -191,6 +195,8 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Channel for accessing a PVRecord.
|
||||
*
|
||||
* A Channel for accessing a record in the PVDatabase.
|
||||
* It is a complete implementation of Channel
|
||||
*/
|
||||
|
@ -46,7 +46,8 @@ typedef std::tr1::shared_ptr<PVCopyMonitorFieldNode> PVCopyMonitorFieldNodePtr;
|
||||
|
||||
|
||||
/**
|
||||
* PVCopyMonitor
|
||||
* @brief Monitor changes to a PVRecord.
|
||||
*
|
||||
* This class manages changes to fields being monitored in a PVRecord.
|
||||
*/
|
||||
class epicsShareClass PVCopyMonitor :
|
||||
@ -154,12 +155,31 @@ private:
|
||||
std::list<PVCopyMonitorFieldNodePtr> monitorFieldNodeList;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Class implemented by monitorFactory
|
||||
*
|
||||
* This is not of interest to users.
|
||||
* It is for communication between monitorfactory and pvCopyMonitor.
|
||||
*
|
||||
*/
|
||||
class epicsShareClass PVCopyMonitorRequester
|
||||
{
|
||||
public:
|
||||
POINTER_DEFINITIONS(PVCopyMonitorRequester);
|
||||
/**
|
||||
*
|
||||
* Destructor
|
||||
*/
|
||||
virtual ~PVCopyMonitorRequester() {}
|
||||
/**
|
||||
* Release active element and return a new element.
|
||||
* @return new element to use.
|
||||
*/
|
||||
virtual epics::pvData::MonitorElementPtr releaseActiveElement() = 0;
|
||||
/**
|
||||
*
|
||||
* stop listening for changes.
|
||||
*/
|
||||
virtual void unlisten() = 0;
|
||||
};
|
||||
|
||||
|
@ -21,6 +21,10 @@ class RecordListRecord;
|
||||
typedef std::tr1::shared_ptr<RecordListRecord> RecordListRecordPtr;
|
||||
|
||||
/**
|
||||
* @brief List records in PVDatabase.
|
||||
*
|
||||
* @deprecated no longer needed because of pvlist command for pvAccess.
|
||||
*
|
||||
* This is a record that provides a PVStringArray that
|
||||
* has the record names of all records in the local PVDatabase.
|
||||
* It is meant to be used by a channelPutGet request.
|
||||
|
@ -18,15 +18,17 @@
|
||||
namespace epics { namespace pvDatabase {
|
||||
|
||||
|
||||
class TraceRecord;
|
||||
typedef std::tr1::shared_ptr<TraceRecord> TraceRecordPtr;
|
||||
|
||||
/**
|
||||
* @brief Trace activity of PVRecord.
|
||||
*
|
||||
* A record to set the trace value for another record
|
||||
* It is meant to be used via a channelPutGet request.
|
||||
* The argument has two fields: recordName and level.
|
||||
* The result has a field named status.
|
||||
*/
|
||||
class TraceRecord;
|
||||
typedef std::tr1::shared_ptr<TraceRecord> TraceRecordPtr;
|
||||
|
||||
class epicsShareClass TraceRecord :
|
||||
public PVRecord
|
||||
{
|
||||
|
Reference in New Issue
Block a user