Package org.epics.archiverappliance.config

Class UserSpecifiedSamplingParams

java.lang.Object

org.epics.archiverappliance.config.UserSpecifiedSamplingParams

All Implemented Interfaces:

Serializable, Comparable<UserSpecifiedSamplingParams>

public class UserSpecifiedSamplingParams
extends Object
implements Comparable<UserSpecifiedSamplingParams>, Serializable

Various options that the user can specify for archiving a PV.

Author:

mshankar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
PolicyConfig.SamplingMethod	userSpecifedsamplingMethod
float	userSpecifedSamplingPeriod

Constructor Summary

Constructors

Constructor	Description
UserSpecifiedSamplingParams()
UserSpecifiedSamplingParams(PolicyConfig.SamplingMethod userSpecifedsamplingMethod, float userSpecifedSamplingPeriod, String controllingPV, String policyName, boolean skipCapacityPlanning, boolean usePVAccess)

Method Summary

Modifier and Type	Method	Description
void	addAlias(String aliasName)
void	addArchiveField(String fieldName)
boolean	checkIfFieldAlreadySepcified(String fieldName)
int	compareTo(UserSpecifiedSamplingParams other)
String[]	getAliases()
String[]	getArchiveFields()
String	getControllingPV()
String	getPolicyName()
PolicyConfig.SamplingMethod	getUserSpecifedsamplingMethod()
float	getUserSpecifedSamplingPeriod()
boolean	isSkipAliasCheck()
boolean	isSkipCapacityPlanning()
boolean	isUsePVAccess()
boolean	isUserOverrideParams()
void	setAliases(String[] aliases)
void	setArchiveFields(String[] archiveFields)
void	setControllingPV(String controllingPV)
void	setPolicyName(String policyName)
void	setSkipAliasCheck(boolean skipAliasCheck)
void	setSkipCapacityPlanning(boolean skipCapacityPlanning)
void	setUsePVAccess(boolean usePVAccess)
void	setUserOverrideParams(boolean userOverrideParams)
void	setUserSpecifedsamplingMethod(PolicyConfig.SamplingMethod userSpecifedsamplingMethod)
void	setUserSpecifedSamplingPeriod(float userSpecifedSamplingPeriod)
boolean	wereAnyFieldsSpecified()

Methods inherited from class java.lang.Object

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

Field Detail

userSpecifedsamplingMethod

public PolicyConfig.SamplingMethod userSpecifedsamplingMethod

userSpecifedSamplingPeriod

public float userSpecifedSamplingPeriod

Constructor Detail

UserSpecifiedSamplingParams

public UserSpecifiedSamplingParams()

UserSpecifiedSamplingParams

public UserSpecifiedSamplingParams(PolicyConfig.SamplingMethod userSpecifedsamplingMethod,
                                   float userSpecifedSamplingPeriod,
                                   String controllingPV,
                                   String policyName,
                                   boolean skipCapacityPlanning,
                                   boolean usePVAccess)

Method Detail

getPolicyName

public String getPolicyName()

setPolicyName

public void setPolicyName(String policyName)

setUserSpecifedsamplingMethod

public void setUserSpecifedsamplingMethod(PolicyConfig.SamplingMethod userSpecifedsamplingMethod)

setUserSpecifedSamplingPeriod

public void setUserSpecifedSamplingPeriod(float userSpecifedSamplingPeriod)

setUserOverrideParams

public void setUserOverrideParams(boolean userOverrideParams)

setControllingPV

public void setControllingPV(String controllingPV)

compareTo

public int compareTo(UserSpecifiedSamplingParams other)

Specified by:

compareTo in interface Comparable<UserSpecifiedSamplingParams>

getUserSpecifedsamplingMethod

public PolicyConfig.SamplingMethod getUserSpecifedsamplingMethod()

getUserSpecifedSamplingPeriod

public float getUserSpecifedSamplingPeriod()

isUserOverrideParams

public boolean isUserOverrideParams()

getControllingPV

public String getControllingPV()

getArchiveFields

public String[] getArchiveFields()

setArchiveFields

public void setArchiveFields(String[] archiveFields)

addArchiveField

public void addArchiveField(String fieldName)

checkIfFieldAlreadySepcified

public boolean checkIfFieldAlreadySepcified(String fieldName)

wereAnyFieldsSpecified

public boolean wereAnyFieldsSpecified()

addAlias

public void addAlias(String aliasName)

getAliases

public String[] getAliases()

setAliases

public void setAliases(String[] aliases)

isSkipAliasCheck

public boolean isSkipAliasCheck()

Returns:

Should we skip checking .NAME to see if this PV is an alias Useful if you have a pCAS server that overloads the .NAME field for something else.

setSkipAliasCheck

public void setSkipAliasCheck(boolean skipAliasCheck)

Parameters:

skipAliasCheck - the skipAliasCheck to set

isUsePVAccess

public boolean isUsePVAccess()

setUsePVAccess

public void setUsePVAccess(boolean usePVAccess)

isSkipCapacityPlanning

public boolean isSkipCapacityPlanning()

setSkipCapacityPlanning

public void setSkipCapacityPlanning(boolean skipCapacityPlanning)