Package org.epics.archiverappliance.mgmt.pva.actions

Class PvaGetPVStatus

java.lang.Object

org.epics.archiverappliance.mgmt.pva.actions.PvaGetPVStatus

All Implemented Interfaces:

PvaAction

public class PvaGetPVStatus
extends Object
implements PvaAction

Get the status of a PV.

pv - The name(s) of the pv for which status is to be determined.

example request

epics:nt/NTTable:1.0

• string[] labels [pv]
• structure value
  • string[] pv [test_0,test_1,test_10,test_100...]

example result:

epics:nt/NTTable:1.0

• string[] labels [pv,status,appliance,connectionState,lastEvent,samplingPeriod,isMonitored,connectionFirstEstablished,connectionLossRegainCount,connectionLastRestablished]
• structure value
  • string[] pv [test_0,test_1,test_10,test_100...]
  • string[] status [Being archived,Initial sampling,Being archived,Being archived,...]
  • string[] connectionState [true,null,true,true,null,true,null,true,null,...]
  • string[] lastEvent [Feb/01/2018 13:18:36 -05:00,null,Feb/01/2018 13:18:37 -05:00,Feb/01/2018 13:18:37 -05:00,...]
  • string[] samplingPeriod [1.0,null,1.0,1.0,null,1.0,null,...]
  • string[] isMonitored [true,null,true,true,null,true,...]
  • string[] connectionFirstEstablished [Feb/01/2018 13:17:10 -05:00,null,...]
  • string[] connectionLossRegainCount [0,null,0,0,null,0,null,...]
  • string[] connectionLastRestablished [Never,null,Never,Never,null,...]

Author:

mshankar, shroffk

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
PvaGetPVStatus()

Method Summary

Modifier and Type	Method	Description
String	getName()	Name of the action
org.epics.pva.data.PVAStructure	request(org.epics.pva.data.PVAStructure args, ConfigService configService)	Handles an RPC request to the archiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

PvaGetPVStatus

public PvaGetPVStatus()

Method Details

getName

public String getName()

Description copied from interface: PvaAction

Name of the action

Specified by:

getName in interface PvaAction

Returns:

the name of the service

request

public org.epics.pva.data.PVAStructure request(org.epics.pva.data.PVAStructure args,
 ConfigService configService)
                                        throws PvaActionException

Description copied from interface: PvaAction

Handles an RPC request to the archiver.

Specified by:

request in interface PvaAction

Parameters:

args - Input arguments

configService - Current config service

Throws:

PvaActionException - which is then passed to the serverPV to return the error to the user.