alma.ACS.impl

Class CommonPropertyImpl

java.lang.Object

alma.ACS.impl.PropertyImpl

alma.ACS.impl.TypelessPropertyImpl

alma.ACS.impl.CommonPropertyImpl

All Implemented Interfaces:

Destroyable, PropertyReferenceHolder, CallbackDispatcher

Direct Known Subclasses:

CommonComparablePropertyImpl, ROCommonPropertyImpl, RWCommonPropertyImpl

public abstract class CommonPropertyImpl
extends TypelessPropertyImpl
implements CallbackDispatcher

Implementation of common property, i.e. type of java.lang.Object.

Author:

Matej Sekoranja

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CommonPropertyImpl.GetAsyncAction BACI action to invoke getSync asynchroniously.
protected class	CommonPropertyImpl.SetAsyncAction BACI action to invoke setSync asynchronously.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataAccess	dataAccess Read-only data access.
protected long	defaultTimerTrigger Default timer trigger (in 100ns units).
protected java.lang.Object	defaultValue Default value.
protected int	historyPosition Pointer in history arrays, points to first empty element.
protected int	historySize History size, if 0 history is disabled.
protected long[]	historyTime Array of history times (OMG standard time).
protected boolean	historyTurnaround true, if values in history arrays exceed end of arrays (circular arrays).
protected java.lang.Object	historyValue Array of history values.
protected java.util.logging.Logger	m_logger Logger variable
protected long	minTimerTrigger Min timer trigger (in 100ns units).
protected Completion	mnemonicCompletion Completion of latest mnemonic value retrival.
protected java.util.concurrent.locks.ReadWriteLock	mnemonicDataLock Mnemonic variables lock.
protected long	mnemonicReadPending Mnemonic read time key of (last) pending read.
protected long	mnemonicTime Time "key" (Java) if when last mnemonic retrival.
protected java.lang.Object	mnemonicValue Value of latest mnemonic value retrival.
protected java.lang.Object	mnemonicValueRetrival Mnemonic read lock (dummy object).
protected java.util.Map	monitors List of all property monitors (needed on property destruction).
protected java.lang.Class	propertyType Property Class type.

Fields inherited from class alma.ACS.impl.TypelessPropertyImpl

description, format, resolution, units

Fields inherited from class alma.ACS.impl.PropertyImpl

characteristicModelImpl, name, parentComponent, propertyRef

Fields inherited from interface alma.ACS.jbaci.CallbackDispatcher

DONE_TYPE, WORKING_TYPE

Constructor Summary

Constructors

Constructor and Description
CommonPropertyImpl(java.lang.Class propertyType, java.lang.String name, CharacteristicComponentImpl parentComponent) Constructor with memory data access.
CommonPropertyImpl(java.lang.Class propertyType, java.lang.String name, CharacteristicComponentImpl parentComponent, DataAccess dataAccess) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addValueToHistory(java.lang.Object value, long timestamp) Add value to the history.
long	default_timer_trigger()
void	destroy() Destroy property.
protected void	getAsync(Callback callback, CBDescIn desc)
DataAccess	getDataAccess() Get property data access layer.
protected java.lang.Object	getHistory(int lastValues, TimeSeqHolder timeSeqHolder)
protected java.lang.Object	getSync(CompletionHolder completionHolder)
long	min_timer_trigger()
java.lang.Object	mnemonicValue(long keyTime, CompletionHolder completionHolder) Mnemonic value retrival.
void	readCharacteristics() Read property characteristics.
abstract java.lang.Object	readPropertyTypeCharacteristic(java.lang.String name) Read property type characteristic.
<T extends org.omg.PortableServer.Servant & OffShootOperations> Monitor	registerMonitor(MonitorOperations monitorImpl, T monitorServant) Register monitor on this property (and optionally CORBA activate).
Monitor	registerNonCorbaMonitor(MonitorOperations monitorImpl) Register monitor on this property, without corba activation.
protected void	setAsync(java.lang.Object value, CBvoid callback, CBDescIn desc)
protected void	setNonblocking(java.lang.Object value)
protected Completion	setSync(java.lang.Object value)
void	unregisterMonitor(MonitorOperations monitorImpl) Unregister monitor on this property (and optionally CORBA deactivate).

Methods inherited from class alma.ACS.impl.TypelessPropertyImpl

archive_now, description, format, publish_now, resolution, set_archive, set_archiving_interval, units

Methods inherited from class alma.ACS.impl.PropertyImpl

characteristic_component_name, find_characteristic, get_all_characteristics, get_characteristic_by_name, getParentComponent, getPropertyDescriptor, getPropertyRef, name, setPropertyRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface alma.ACS.jbaci.CallbackDispatcher

dispatchCallback

Field Detail

m_logger

protected java.util.logging.Logger m_logger

Logger variable

defaultTimerTrigger

protected long defaultTimerTrigger

Default timer trigger (in 100ns units).

minTimerTrigger

protected long minTimerTrigger

Min timer trigger (in 100ns units).

defaultValue

protected java.lang.Object defaultValue

Default value.

dataAccess

protected DataAccess dataAccess

Read-only data access.

propertyType

protected java.lang.Class propertyType

Property Class type.

historySize

protected int historySize

History size, if 0 history is disabled.

historyPosition

protected int historyPosition

Pointer in history arrays, points to first empty element.

historyTurnaround

protected boolean historyTurnaround

true, if values in history arrays exceed end of arrays (circular arrays).

historyValue

protected java.lang.Object historyValue

Array of history values.

historyTime

protected long[] historyTime

Array of history times (OMG standard time).

monitors

protected java.util.Map monitors

List of all property monitors (needed on property destruction).

mnemonicReadPending

protected long mnemonicReadPending

Mnemonic read time key of (last) pending read.

mnemonicValueRetrival

protected java.lang.Object mnemonicValueRetrival

Mnemonic read lock (dummy object).

mnemonicDataLock

protected java.util.concurrent.locks.ReadWriteLock mnemonicDataLock

Mnemonic variables lock.

mnemonicTime

protected long mnemonicTime

Time "key" (Java) if when last mnemonic retrival.

mnemonicValue

protected java.lang.Object mnemonicValue

Value of latest mnemonic value retrival.

mnemonicCompletion

protected Completion mnemonicCompletion

Completion of latest mnemonic value retrival.

Constructor Detail

CommonPropertyImpl

public CommonPropertyImpl(java.lang.Class propertyType,
                          java.lang.String name,
                          CharacteristicComponentImpl parentComponent)
                   throws PropertyInitializationFailed

Constructor with memory data access.

Parameters:

propertyType - property Class type, non-null.

name - property name, non-null.

parentComponent - parent component, non-null.

Throws:

PropertyInitializationFailed - exception is thrown on failure

CommonPropertyImpl

public CommonPropertyImpl(java.lang.Class propertyType,
                          java.lang.String name,
                          CharacteristicComponentImpl parentComponent,
                          DataAccess dataAccess)
                   throws PropertyInitializationFailed

Constructor.

Parameters:

propertyType - property Class type, non-null.

name - property name, non-null.

parentComponent - parent component, non-null.

dataAccess - read-write data access to be use, non-null.

Throws:

PropertyInitializationFailed - exception is thrown on failure

Method Detail

readCharacteristics

public void readCharacteristics()
                         throws PropertyInitializationFailed

Read property characteristics.

Overrides:

readCharacteristics in class TypelessPropertyImpl

Throws:

PropertyInitializationFailed - exception is thrown on failure

getDataAccess

public DataAccess getDataAccess()

Get property data access layer.

Returns:

property data access.

destroy

public void destroy()

Description copied from class: PropertyImpl

Destroy property.

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class PropertyImpl

See Also:

alma.ACS.PropertyImpl#destroy()

default_timer_trigger

public long default_timer_trigger()

See Also:

alma.ACS.POperations#default_timer_trigger()

min_timer_trigger

public long min_timer_trigger()

See Also:

alma.ACS.POperations#min_timer_trigger()

readPropertyTypeCharacteristic

public abstract java.lang.Object readPropertyTypeCharacteristic(java.lang.String name)
                                                         throws NoSuchCharacteristic

Read property type characteristic.

Throws:

NoSuchCharacteristic - is thrown if characterstic does not exist.

addValueToHistory

protected void addValueToHistory(java.lang.Object value,
                                 long timestamp)

Add value to the history.

Parameters:

value - value to be added to the history.

timestamp - value timestamp (OMG) to be added to the history.

getHistory

protected java.lang.Object getHistory(int lastValues,
                                      TimeSeqHolder timeSeqHolder)

getSync

protected java.lang.Object getSync(CompletionHolder completionHolder)
                            throws AcsJException

Throws:

AcsJException

See Also:

alma.ACS.POperations#get_sync(alma.ACSErr.CompletionHolder)

getAsync

protected void getAsync(Callback callback,
                        CBDescIn desc)

See Also:

alma.ACS.POperations#get_async(alma.ACS.CB, alma.ACS.CBDescIn)

registerMonitor

public <T extends org.omg.PortableServer.Servant & OffShootOperations> Monitor registerMonitor(MonitorOperations monitorImpl,
                                                                                               T monitorServant)

Register monitor on this property (and optionally CORBA activate). Registration is needed for monitor destruction on property destruction.

Parameters:

monitorImpl - monitor implementation (e.g. class implementing MonitorOperations interface).

monitorServant - monitor CORBA servant (e.g. MonitorPOATie class). If null monitor will be treated as non-CORBA monitor and no CORBA activation will be done. (Not sure how to correctly pass a null, now that the method uses generics. See registerNonCorbaMonitor(MonitorOperations) for an alternative call.)

Returns:

CORBA activated monitor reference, null if monitorServant == null.

registerNonCorbaMonitor

public Monitor registerNonCorbaMonitor(MonitorOperations monitorImpl)

Register monitor on this property, without corba activation. Registration is needed for monitor destruction on property destruction.

Note that this method was broken out from registerMonitor(MonitorOperations, Servant) to avoid passing null as the second argument of that method, which was in conflict with the generics definition, which in turn was added there to match the one of ContainerServices.activateOffshoot.

Parameters:

monitorImpl - monitor implementation (e.g. class implementing MonitorOperations interface).

Returns:

CORBA activated monitor reference, null if monitorServant == null.

unregisterMonitor

public void unregisterMonitor(MonitorOperations monitorImpl)

Unregister monitor on this property (and optionally CORBA deactivate). Should be called by MonitorOperations.destroy() method.

setSync

protected Completion setSync(java.lang.Object value)
                      throws AcsJException

Throws:

AcsJException

See Also:

alma.ACS.RWOperations#set_sync()

setAsync

protected void setAsync(java.lang.Object value,
                        CBvoid callback,
                        CBDescIn desc)

See Also:

alma.ACS.RWOperations#get_async(, alma.ACS.CBvoid, alma.ACS.CBDescIn)

setNonblocking

protected void setNonblocking(java.lang.Object value)

See Also:

alma.ACS.RWOperations#set_nonblocking()

mnemonicValue

public java.lang.Object mnemonicValue(long keyTime,
                                      CompletionHolder completionHolder)

Mnemonic value retrival. If keyTime == mnemonicTime cached mnemonic value is returned.

Parameters:

keyTime - time (java) of mnemonic request.

completionHolder - completion holder that will be given completion. NOTE: completion is passsed by reference, so do not change its value, copy its value before and do it on a local copy

Returns:

current property value.

See Also:

getSync