Class PVTypeInfo

  • All Implemented Interfaces:
    Serializable

    public class PVTypeInfo
    extends Object
    implements Serializable
    Somewhat static information about a PV like it's type info, graphic limits, event rates etc.
    Author:
    mshankar
    See Also:
    Serialized Form
    • Field Detail

      • DEFAULT_BUFFER_INTERVAL

        public static final int DEFAULT_BUFFER_INTERVAL
        See Also:
        Constant Field Values
    • Constructor Detail

      • PVTypeInfo

        public PVTypeInfo()
      • PVTypeInfo

        public PVTypeInfo​(String pvName,
                          ArchDBRTypes dBRType,
                          boolean isScalar,
                          int elementCount)
    • Method Detail

      • getPvName

        public String getPvName()
      • isScalar

        public boolean isScalar()
      • getElementCount

        public int getElementCount()
      • getUpperDisplayLimit

        public Double getUpperDisplayLimit()
      • getLowerDisplayLimit

        public Double getLowerDisplayLimit()
      • isHasReducedDataSet

        public boolean isHasReducedDataSet()
      • getComputedEventRate

        public float getComputedEventRate()
      • getUserSpecifiedEventRate

        public float getUserSpecifiedEventRate()
      • getCreationTime

        public Timestamp getCreationTime()
      • setCreationTime

        public void setCreationTime​(Timestamp creationTime)
      • getModificationTime

        public Timestamp getModificationTime()
      • setModificationTime

        public void setModificationTime​(Timestamp modificationTime)
      • isPaused

        public boolean isPaused()
      • setPaused

        public void setPaused​(boolean paused)
      • setPvName

        public void setPvName​(String pvName)
      • setDBRType

        public void setDBRType​(ArchDBRTypes dBRType)
      • setScalar

        public void setScalar​(boolean isScalar)
      • setElementCount

        public void setElementCount​(int elementCount)
      • setUpperDisplayLimit

        public void setUpperDisplayLimit​(Double upperDisplayLimit)
      • setLowerDisplayLimit

        public void setLowerDisplayLimit​(Double lowerDisplayLimit)
      • setHasReducedDataSet

        public void setHasReducedDataSet​(boolean hasReducedDataSet)
      • setComputedEventRate

        public void setComputedEventRate​(float computedEventRate)
      • setUserSpecifiedEventRate

        public void setUserSpecifiedEventRate​(float userSpecifiedEventRate)
      • getSamplingPeriod

        public float getSamplingPeriod()
      • setSamplingPeriod

        public void setSamplingPeriod​(float samplingPeriod)
      • getDataStores

        public String[] getDataStores()
      • setDataStores

        public void setDataStores​(String[] dataStores)
      • getApplianceIdentity

        public String getApplianceIdentity()
      • setApplianceIdentity

        public void setApplianceIdentity​(String applianceIdentity)
      • parsePolicyRepresentation

        public void parsePolicyRepresentation​(String typeInfoStr)
        Parse a string (JSON) representation of the PVTypeInfo object into this object
        Parameters:
        typeInfoStr -  
      • getLowerAlarmLimit

        public Double getLowerAlarmLimit()
      • setLowerAlarmLimit

        public void setLowerAlarmLimit​(Double lowerAlarmLimit)
      • getLowerCtrlLimit

        public Double getLowerCtrlLimit()
      • setLowerCtrlLimit

        public void setLowerCtrlLimit​(Double lowerCtrlLimit)
      • getLowerWarningLimit

        public Double getLowerWarningLimit()
      • setLowerWarningLimit

        public void setLowerWarningLimit​(Double lowerWarningLimit)
      • getUpperAlarmLimit

        public Double getUpperAlarmLimit()
      • setUpperAlarmLimit

        public void setUpperAlarmLimit​(Double upperAlarmLimit)
      • getUpperCtrlLimit

        public Double getUpperCtrlLimit()
      • setUpperCtrlLimit

        public void setUpperCtrlLimit​(Double upperCtrlLimit)
      • getUpperWarningLimit

        public Double getUpperWarningLimit()
      • setUpperWarningLimit

        public void setUpperWarningLimit​(Double upperWarningLimit)
      • getPrecision

        public Double getPrecision()
      • setPrecision

        public void setPrecision​(Double precision)
      • getUnits

        public String getUnits()
      • setUnits

        public void setUnits​(String units)
      • absorbMetaInfo

        public void absorbMetaInfo​(MetaInfo metaInfo)
      • hasExtraField

        public boolean hasExtraField​(String key)
      • lookupExtraField

        public String lookupExtraField​(String key)
      • getPolicyName

        public String getPolicyName()
      • setPolicyName

        public void setPolicyName​(String policyName)
      • getComputedStorageRate

        public float getComputedStorageRate()
      • setComputedStorageRate

        public void setComputedStorageRate​(float computedStorageRate)
      • getComputedBytesPerEvent

        public int getComputedBytesPerEvent()
      • setComputedBytesPerEvent

        public void setComputedBytesPerEvent​(int computedBytesPerEvent)
      • getControllingPV

        public String getControllingPV()
      • setControllingPV

        public void setControllingPV​(String controllingPV)
      • getArchiveFields

        public String[] getArchiveFields()
      • obtainArchiveFieldsAsString

        public String obtainArchiveFieldsAsString()
      • setArchiveFields

        public void setArchiveFields​(String[] archiveFields)
      • addArchiveField

        public void addArchiveField​(String fieldName)
      • checkIfFieldAlreadySepcified

        public boolean checkIfFieldAlreadySepcified​(String fieldName)
      • determineLastKnownEventFromStores

        public Timestamp determineLastKnownEventFromStores​(ConfigService configService)
                                                    throws IOException
        Loop thru the stores outlined in this typeinfo and determine the most recent event for this pv
        Parameters:
        configService - ConfigService
        Returns:
        Timestamp  
        Throws:
        IOException -  
      • getSecondsToBuffer

        public static int getSecondsToBuffer​(ConfigService configService)
        The secondsToBuffer is a system wide property. Use this method to get the proper defaults.
        Parameters:
        configService - ConfigService
        Returns:
        secondsToBuffer  
      • getChunkKey

        public String getChunkKey()
        The archiver appliance stores data in chunks that have a well defined key. We record this key in the typeinfo (to accommodate slowly changing key mapping strategies)
        Returns:
        chunkKey  
      • setChunkKey

        public void setChunkKey​(String chunkKey)
      • keyAlreadyGenerated

        public boolean keyAlreadyGenerated()
      • getHostName

        public String getHostName()
        Returns:
        hostName  
      • setHostName

        public void setHostName​(String hostName)
        Parameters:
        hostName -  
      • isUsePVAccess

        public boolean isUsePVAccess()
      • setUsePVAccess

        public void setUsePVAccess​(boolean usePVAccess)
      • isUseDBEProperties

        public boolean isUseDBEProperties()
      • setUseDBEProperties

        public void setUseDBEProperties​(boolean useDBEProperties)