areaDetector  3-7-0
EPICS areaDetector framework
Public Member Functions | List of all members
paramAttribute Class Reference

Attribute that gets its value from an asynNDArrayDriver driver parameter. More...

#include <paramAttribute.h>

Inheritance diagram for paramAttribute:
NDAttribute

Public Member Functions

 paramAttribute (const char *pName, const char *pDescription, const char *pSource, int addr, class asynNDArrayDriver *pDriver, const char *dataType)
 Constructor for driver/plugin attribute. More...
 
 paramAttribute (paramAttribute &attribute)
 Copy constructor for driver/plugin attribute. More...
 
 ~paramAttribute ()
 Destructor for driver/plugin attribute. More...
 
paramAttributecopy (NDAttribute *pAttribute)
 Copies properties from this to pOut. More...
 
int updateValue ()
 Updates the current value of this attribute; sets the attribute value to the current value of the driver/plugin parameter in the parameter library. More...
 
int report (FILE *fp, int details)
 Reports on the properties of the paramAttribute object; calls base class NDAttribute::report() to report on the parameter value. More...
 
- Public Member Functions inherited from NDAttribute
 NDAttribute (const char *pName, const char *pDescription, NDAttrSource_t sourceType, const char *pSource, NDAttrDataType_t dataType, void *pValue)
 NDAttribute constructor. More...
 
 NDAttribute (NDAttribute &attribute)
 NDAttribute copy constructor. More...
 
virtual ~NDAttribute ()
 NDAttribute destructor. More...
 
virtual const char * getName ()
 Returns the name of this attribute. More...
 
virtual const char * getDescription ()
 Returns the description of this attribute. More...
 
virtual const char * getSource ()
 Returns the source string of this attribute. More...
 
virtual const char * getSourceInfo (NDAttrSource_t *pSourceType)
 Returns the source information of this attribute. More...
 
virtual NDAttrDataType_t getDataType ()
 Returns the data type of this attribute. More...
 
virtual int getValueInfo (NDAttrDataType_t *pDataType, size_t *pDataSize)
 Returns the data type and size of this attribute. More...
 
virtual int getValue (NDAttrDataType_t dataType, void *pValue, size_t dataSize=0)
 Returns the value of this attribute. More...
 
virtual int getValue (std::string &value)
 Returns the value of an NDAttrString attribute as an std::string. More...
 
virtual int setDataType (NDAttrDataType_t dataType)
 Sets the data type of this attribute. More...
 
virtual int setValue (const void *pValue)
 Sets the value for this attribute. More...
 
virtual int setValue (const std::string &)
 Sets the value for this attribute. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from NDAttribute
static const char * attrSourceString (NDAttrSource_t type)
 

Detailed Description

Attribute that gets its value from an asynNDArrayDriver driver parameter.

The updateValue() method for this class retrieves the current value of the driver parameter.

Constructor & Destructor Documentation

◆ paramAttribute() [1/2]

paramAttribute::paramAttribute ( const char *  pName,
const char *  pDescription,
const char *  pSource,
int  addr,
class asynNDArrayDriver pDriver,
const char *  dataType 
)

Constructor for driver/plugin attribute.

Parameters
[in]pNameThe name of the attribute to be created; case-insensitive.
[in]pDescriptionThe description of the attribute.
[in]pSourceThe DRV_INFO string used to identify the parameter in the asynPortDriver.
[in]addrThe asyn addr (address) for this parameter.
[in]pDriverThe driver or plugin object from which to obtain the parameter.
[in]dataTypeThe data type for this parameter. Must be "INT", "DOUBLE", or "STRING" (case-insensitive).

◆ paramAttribute() [2/2]

paramAttribute::paramAttribute ( paramAttribute attribute)

Copy constructor for driver/plugin attribute.

Parameters
[in]attributeA paramAttribute to copy from

◆ ~paramAttribute()

paramAttribute::~paramAttribute ( )

Destructor for driver/plugin attribute.

Member Function Documentation

◆ copy()

paramAttribute * paramAttribute::copy ( NDAttribute pOut)
virtual

Copies properties from this to pOut.

Parameters
[in]pOutA pointer to the output attribute If NULL the output attribute will be created using the copy constructor Only the value is copied, all other fields are assumed to already be the same in pOut
Returns
Returns a pointer to the copy

Reimplemented from NDAttribute.

◆ report()

int paramAttribute::report ( FILE *  fp,
int  details 
)
virtual

Reports on the properties of the paramAttribute object; calls base class NDAttribute::report() to report on the parameter value.

Parameters
[in]fpFile pointer for the report output.
[in]detailsLevel of report details desired; currently does nothing in this derived class.

Reimplemented from NDAttribute.

◆ updateValue()

int paramAttribute::updateValue ( )
virtual

Updates the current value of this attribute; sets the attribute value to the current value of the driver/plugin parameter in the parameter library.

Reimplemented from NDAttribute.


The documentation for this class was generated from the following files: