alma::ACS::jbaci::DataAccess Interface Reference

Inheritance diagram for alma::ACS::jbaci::DataAccess:

[legend]

List of all members.

Classes
class	OnChangeNotSupportedException
interface	ValueChangeListener
Public Member Functions
void	addValueChangeListener (ValueChangeListener listener) throws OnChangeNotSupportedException
void	removeValueChangeListener (ValueChangeListener listener)
Object	get (CompletionHolder completionHolder) throws AcsJException
boolean	initializeValue ()
void	set (Object value, CompletionHolder completion) throws AcsJException

---

Detailed Description

Data access interface.

Author:

Matej Sekoranja

Version:

$id$

---

Member Function Documentation

void alma::ACS::jbaci::DataAccess::addValueChangeListener

(

ValueChangeListener

listener

)

throws OnChangeNotSupportedException

Add value change listener.

Parameters:

listener

listener to be notified on every value change.

Exceptions:

NotSupportedException

throws id this DataAccess does not support on-change notifications - exeptions provides recommended pool time property.

See also:

NotSupportedException

Implemented in alma::ACS::jbaci::DataAccessSupport, alma::PS::PowerSupplyImpl::ReadbackDataAccess, alma::TT::SeqComponentImpl::readbackLongSeqDataAccess, alma::TT::SeqComponentImpl::readbackDoubleSeqDataAccess, and alma::TT::SeqComponentImpl::readbackFloatSeqDataAccess.

Object alma::ACS::jbaci::DataAccess::get

(

CompletionHolder

completionHolder

)

throws AcsJException

Retrieve value or throw AcsJExcption in case of failure.

Parameters:

completionHolder

completion holder. If completionHolder.value is left to null (by this method), caller is responsible to create a no-error completion with current timestamp later. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Returns:

read value, non-null.

Exceptions:

ACS

exception if case of failure.

See also:

alma.ACS.jbaci.CompletionUtil::generateNoErrorCompletion()

Implemented in alma::ACS::jbaci::MemoryDataAccess, alma::PS::PowerSupplyImpl::StatusDataAccess, alma::PS::PowerSupplyImpl::ReadbackDataAccess, alma::TT::PrimComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::readbackLongSeqDataAccess, alma::TT::SeqComponentImpl::readbackDoubleSeqDataAccess, and alma::TT::SeqComponentImpl::readbackFloatSeqDataAccess.

Referenced by alma::PS::PowerSupplyImpl::ReadbackDataAccess::get(), and alma::ACS::impl::CommonPropertyImpl::getSync().

boolean alma::ACS::jbaci::DataAccess::initializeValue

(

)

Flag indicating if property should initialize value (to default value) when initializing.

Returns:

flag indicating if property should initialize value (to default value) when initializing.

Implemented in alma::ACS::jbaci::MemoryDataAccess, alma::PS::PowerSupplyImpl::StatusDataAccess, alma::PS::PowerSupplyImpl::ReadbackDataAccess, alma::TT::PrimComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::readbackLongSeqDataAccess, alma::TT::SeqComponentImpl::readbackDoubleSeqDataAccess, and alma::TT::SeqComponentImpl::readbackFloatSeqDataAccess.

Referenced by alma::ACS::impl::CommonPropertyImpl::CommonPropertyImpl().

void alma::ACS::jbaci::DataAccess::removeValueChangeListener

(

ValueChangeListener

listener

)

Remove value change listener.

Parameters:

listener

listener to be removed.

Implemented in alma::ACS::jbaci::DataAccessSupport, alma::PS::PowerSupplyImpl::ReadbackDataAccess, alma::TT::SeqComponentImpl::readbackLongSeqDataAccess, alma::TT::SeqComponentImpl::readbackDoubleSeqDataAccess, and alma::TT::SeqComponentImpl::readbackFloatSeqDataAccess.

void alma::ACS::jbaci::DataAccess::set	(	Object	value,
		CompletionHolder	completion
	)			throws AcsJException

Set value or throw AcsJExcption in case of failure.

Parameters:

	value	value to be set, non-null.
	completionHolder	completion holder. If completionHolder.value is left to null (by this method), caller is responsible to create a no-error completion with current timestamp later. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Exceptions:

ACS

exception if case of failure.

Implemented in alma::ACS::jbaci::MemoryDataAccess, alma::PS::PowerSupplyImpl::StatusDataAccess, alma::PS::PowerSupplyImpl::ReadbackDataAccess, alma::TT::PrimComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::StatusDataAccess, alma::TT::SeqComponentImpl::readbackLongSeqDataAccess, alma::TT::SeqComponentImpl::readbackDoubleSeqDataAccess, and alma::TT::SeqComponentImpl::readbackFloatSeqDataAccess.

Referenced by alma::ACS::impl::CommonPropertyImpl::CommonPropertyImpl(), alma::ACS::impl::CommonPropertyImpl::setSync(), and alma::ACS::MasterComponentImpl::MasterComponentImplBase::updateStateHierarchy().

---

The documentation for this interface was generated from the following file:

• DataAccess.java