Package org.epics.pvdata.property

Interface PVProperty

  • public interface PVProperty
    An interface for locating property fields.
    Author:
    mrk

    • Method Detail

      • findProperty

        PVField findProperty​(PVField pvField,
                     String fieldName)
        Find a property by looking for a field by name.
        Parameters:
        pvField - The pvField.
        fieldName - the name of the field to search for. Will consist of a number of strings separated by periods.
        Returns:
        the PVField interface for the property or null if not found

      • findPropertyViaParent

        PVField findPropertyViaParent​(PVField pvField,
                              String propertyName)
        Find a property by searching up the parent tree.
        Parameters:
        pvField - the pvField
        propertyName - the property name which is expected to match the name of a field
        Returns:
        the interface to the first field found that is not a null structure or null if not found

      • getPropertyNames

        String[] getPropertyNames​(PVField pvField)
        Get the names of all the properties for this PVField. A property name is the field name. If this PVfield is a structure then every field except null structures is a property. If this PVField is the value field the parent is the starting point and the properties will not include the value field itself. In addition a search up the parent tree is made for the timeStamp.
        Parameters:
        pvField - the pvField
        Returns:
        the String array for the names of the properties