org.epics.ioc.pv
Interface PVField

All Superinterfaces:
Requester
All Known Subinterfaces:
PVArray, PVArrayArray, PVBoolean, PVBooleanArray, PVByte, PVByteArray, PVDouble, PVDoubleArray, PVEnum, PVEnumArray, PVFloat, PVFloatArray, PVInt, PVIntArray, PVLink, PVLinkArray, PVLong, PVLongArray, PVMenu, PVMenuArray, PVRecord, PVShort, PVShortArray, PVString, PVStringArray, PVStructure, PVStructureArray
All Known Implementing Classes:
AbstractPVArray, AbstractPVField, BasePVEnum, BasePVLink, BasePVMenu, BasePVRecord, BasePVStructure

public interface PVField
extends Requester

PVField is the base class for each PVData field. Each PVType has an interface that extends PVField.

Author:
mrk

Method Summary
 Field getField()
          Get the Field that describes the field.
 java.lang.String getFullFieldName()
          Get the fullFieldName, i.e.
 java.lang.String getFullName()
          Get the full name, which is the recordName plus the fullFieldName
 PVField getParent()
          Get the parent of this field.
 PVRecord getPVRecord()
          Get the record.
 java.lang.String getSupportName()
          Get the support name if it exists.
 void replacePVField(PVField newPVField)
          Replace the data implementation for a field.
 void setSupportName(java.lang.String name)
          Set the name of the support or null to specify no support.
 java.lang.String toString()
          Convert the PVField to a string.
 java.lang.String toString(int indentLevel)
          Convert the PVField to a string.
 
Methods inherited from interface org.epics.ioc.util.Requester
getRequesterName, message
 

Method Detail

getFullFieldName

java.lang.String getFullFieldName()
Get the fullFieldName, i.e. the complete hierarchy.

Returns:
The name.

getFullName

java.lang.String getFullName()
Get the full name, which is the recordName plus the fullFieldName

Returns:
The name.

getField

Field getField()
Get the Field that describes the field.

Returns:
Field, which is the reflection interface.

getParent

PVField getParent()
Get the parent of this field. The parent can be a PVStructure, PVLink, or PVArray.

Returns:
The parent interface.

getPVRecord

PVRecord getPVRecord()
Get the record.

Returns:
The record interface.

replacePVField

void replacePVField(PVField newPVField)
Replace the data implementation for a field.

Parameters:
newPVField - The new implementation for this field.

getSupportName

java.lang.String getSupportName()
Get the support name if it exists.

Returns:
The name of the support.

setSupportName

void setSupportName(java.lang.String name)
Set the name of the support or null to specify no support.

Parameters:
name - The name.

toString

java.lang.String toString()
Convert the PVField to a string.

Overrides:
toString in class java.lang.Object
Returns:
The string.

toString

java.lang.String toString(int indentLevel)
Convert the PVField to a string. Each line is indented.

Parameters:
indentLevel - The indentation level.
Returns:
The string.