alma::ACS::impl::CommonROEnumPropertyImpl Class Reference

Inheritance diagram for alma::ACS::impl::CommonROEnumPropertyImpl:

Collaboration diagram for alma::ACS::impl::CommonROEnumPropertyImpl:

Classes
class	ROEnumProxy
Public Member Functions
Condition[]	condition ()
String[]	statesDescription ()
Subscription	new_subscription_AlarmEnum (Alarmpattern cb, CBDescIn desc)
Monitorpattern	create_monitor (CBpattern cb, CBDescIn desc)
Monitor	create_postponed_monitor (long start_time, CBpattern cb, CBDescIn desc)
void	get_async (CBpattern cb, CBDescIn desc)
Object	readPropertyTypeCharacteristic (String name) throws NoSuchCharacteristic
boolean	dispatchCallback (int type, Object value, Callback callback, Completion completion, CBDescOut desc)
Object	alarm_on ()
Object	alarm_off ()
Object	allStates ()
Object	default_value ()
Object	get_sync (CompletionHolder c)
Static Public Member Functions
static Object	createEnumProperty (Class operationsIF, Class propertyType, String name, CharacteristicComponentImpl parentComponent) throws PropertyInitializationFailed
static Object	createEnumProperty (Class operationsIF, Class propertyType, String name, CharacteristicComponentImpl parentComponent, DataAccess dataAccess) throws PropertyInitializationFailed
Protected Member Functions
void	initialize () throws PropertyInitializationFailed
int	value (Object value)
Object	from_int (int value)
Package Functions
	CommonROEnumPropertyImpl (Class enumClass, String name, CharacteristicComponentImpl parentComponent) throws PropertyInitializationFailed
	CommonROEnumPropertyImpl (Class enumClass, String name, CharacteristicComponentImpl parentComponent, DataAccess dataAccess) throws PropertyInitializationFailed
Private Member Functions
Object	getEnumArrayFromCharacteristicModel (String name)
Private Attributes
Method	from_int_method
Method	value_method

Detailed Description

Base enum class. Contains common methods that does not contain enumClass class in method' signatures. enumClass must has standard Java CORBA generated metods of called fromInt(int) and value().

Author:: msekoranja

Constructor & Destructor Documentation

alma::ACS::impl::CommonROEnumPropertyImpl::CommonROEnumPropertyImpl	(	Class	enumClass,
		String	name,
		CharacteristicComponentImpl	parentComponent
	)			throws PropertyInitializationFailed `[inline, package]`

Parameters:

	name
	parentComponent

Exceptions:

PropertyInitializationFailed

References initialize(), alma::ACS::impl::PropertyImpl::name(), and alma::ACS::impl::PropertyImpl::parentComponent.

Referenced by createEnumProperty().

alma::ACS::impl::CommonROEnumPropertyImpl::CommonROEnumPropertyImpl	(	Class	enumClass,
		String	name,
		CharacteristicComponentImpl	parentComponent,
		DataAccess	dataAccess
	)			throws PropertyInitializationFailed `[inline, package]`

Parameters:

	name
	parentComponent
	dataAccess

Exceptions:

PropertyInitializationFailed

References alma::ACS::impl::CommonPropertyImpl::dataAccess, initialize(), alma::ACS::impl::PropertyImpl::name(), and alma::ACS::impl::PropertyImpl::parentComponent.

Member Function Documentation

Object alma::ACS::impl::CommonROEnumPropertyImpl::alarm_off ( ) [inline]

References getEnumArrayFromCharacteristicModel().

Object alma::ACS::impl::CommonROEnumPropertyImpl::alarm_on ( ) [inline]

References getEnumArrayFromCharacteristicModel().

Object alma::ACS::impl::CommonROEnumPropertyImpl::allStates ( ) [inline]

References from_int(), and alma::ACS::impl::CommonPropertyImpl::propertyType.

Condition [] alma::ACS::impl::CommonROEnumPropertyImpl::condition ( ) [inline]

References alma::ACS::impl::PropertyImpl::characteristicModelImpl, alma::ACS::Condition::from_int(), and alma::ACS::impl::CharacteristicModelImpl::getIntegerSeq().

Monitorpattern alma::ACS::impl::CommonROEnumPropertyImpl::create_monitor	(	CBpattern	cb,
		CBDescIn	desc
	)			`[inline]`

References create_postponed_monitor().

Monitor alma::ACS::impl::CommonROEnumPropertyImpl::create_postponed_monitor	(	long	start_time,
		CBpattern	cb,
		CBDescIn	desc
	)			`[inline]`

References alma::ACS::impl::CommonPropertyImpl::registerMonitor().

Referenced by create_monitor().

static Object alma::ACS::impl::CommonROEnumPropertyImpl::createEnumProperty	(	Class	operationsIF,
		Class	propertyType,
		String	name,
		CharacteristicComponentImpl	parentComponent,
		DataAccess	dataAccess
	)			throws PropertyInitializationFailed `[inline, static]`

Create RO enum structure. Example: BasicStatesOperations basicStatesEnumImpl = (BasicStatesOperations)CommonROEnumPropertyImpl.createEnumProperty( BasicStatesOperations.class, BasicStates.class, "state", parentComponent, dataAccess);

Parameters:

	operationsIF	CORBA <enum type>="">Operations class.
	propertyType	CORBA enum class.
	name	name of the property.
	parentComponent	property component.
	dataAccess	data access to be used.

Returns:: CORBA <enum type>="">Operations instance.

Exceptions:

PropertyInitializationFailed

Reimplemented in alma::ACS::impl::CommonRWEnumPropertyImpl.

References CommonROEnumPropertyImpl(), alma::ACS::impl::CommonPropertyImpl::dataAccess, alma::ACS::impl::PropertyImpl::name(), alma::ACS::impl::PropertyImpl::parentComponent, and alma::ACS::impl::CommonPropertyImpl::propertyType.

static Object alma::ACS::impl::CommonROEnumPropertyImpl::createEnumProperty	(	Class	operationsIF,
		Class	propertyType,
		String	name,
		CharacteristicComponentImpl	parentComponent
	)			throws PropertyInitializationFailed `[inline, static]`

Create default in-memory RO enum structure.

See also:: createEnumProperty(Class, Class, String, CharacteristicComponentImpl, DataAccess)

References alma::ACS::impl::PropertyImpl::name(), alma::ACS::impl::PropertyImpl::parentComponent, and alma::ACS::impl::CommonPropertyImpl::propertyType.

Object alma::ACS::impl::CommonROEnumPropertyImpl::default_value ( ) [inline]

References alma::ACS::impl::PropertyImpl::characteristicModelImpl, from_int(), and alma::ACS::impl::CharacteristicModelImpl::getInteger().

Referenced by get_sync().

boolean alma::ACS::impl::CommonROEnumPropertyImpl::dispatchCallback	(	int	type,
		Object	value,
		Callback	callback,
		Completion	completion,
		CBDescOut	desc
	)			`[inline]`

Dispatches a callback.

Parameters:

	type	type of the callback (not strong typed to be flexible?!).
	value	value to be delivered.
	callback	callback.
	competion	completion.
	desc	callback out-descriptor.

Returns:: true if callback was successfully delivered, false on failure.

Implements alma::ACS::jbaci::CallbackDispatcher.

References value().

Object alma::ACS::impl::CommonROEnumPropertyImpl::from_int ( int value ) [inline, protected]

References from_int_method, and initialize().

Referenced by allStates(), default_value(), getEnumArrayFromCharacteristicModel(), and readPropertyTypeCharacteristic().

void alma::ACS::impl::CommonROEnumPropertyImpl::get_async	(	CBpattern	cb,
		CBDescIn	desc
	)			`[inline]`

References alma::ACS::impl::CommonPropertyImpl::getAsync().

Object alma::ACS::impl::CommonROEnumPropertyImpl::get_sync ( CompletionHolder c ) [inline]

References default_value(), alma::ACS::impl::CommonPropertyImpl::getSync(), and alma::ACSErr::CompletionHolder::value.

Object alma::ACS::impl::CommonROEnumPropertyImpl::getEnumArrayFromCharacteristicModel ( String name ) [inline, private]

References alma::ACS::impl::PropertyImpl::characteristicModelImpl, from_int(), alma::ACS::impl::CharacteristicModelImpl::getIntegerSeq(), and alma::ACS::impl::CommonPropertyImpl::propertyType.

Referenced by alarm_off(), and alarm_on().

void alma::ACS::impl::CommonROEnumPropertyImpl::initialize ( ) throws PropertyInitializationFailed [inline, protected]

References from_int_method, alma::ACS::impl::CommonPropertyImpl::propertyType, and value_method.

Referenced by CommonROEnumPropertyImpl(), and from_int().

Subscription alma::ACS::impl::CommonROEnumPropertyImpl::new_subscription_AlarmEnum	(	Alarmpattern	cb,
		CBDescIn	desc
	)			`[inline]`

Object alma::ACS::impl::CommonROEnumPropertyImpl::readPropertyTypeCharacteristic ( String name ) throws NoSuchCharacteristic [inline, virtual]

Read property type characteristic.

Exceptions:

NoSuchCharacteristic

is thrown if characterstic does not exist.

Implements alma::ACS::impl::CommonPropertyImpl.

References alma::ACS::impl::PropertyImpl::characteristicModelImpl, from_int(), alma::ACS::impl::CharacteristicModelImpl::getInteger(), and alma::ACS::impl::PropertyImpl::name().

String [] alma::ACS::impl::CommonROEnumPropertyImpl::statesDescription ( ) [inline]

References alma::ACS::impl::PropertyImpl::characteristicModelImpl, and alma::ACS::impl::CharacteristicModelImpl::getStringSeq().

int alma::ACS::impl::CommonROEnumPropertyImpl::value ( Object value ) [inline, protected]

References value_method.

Referenced by dispatchCallback().

Member Data Documentation

Method alma::ACS::impl::CommonROEnumPropertyImpl::from_int_method [private]

Referenced by from_int(), and initialize().

Method alma::ACS::impl::CommonROEnumPropertyImpl::value_method [private]

Referenced by initialize(), and value().

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

CommonROEnumPropertyImpl.java

alma::ACS::impl::CommonROEnumPropertyImpl Class Reference

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Package Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation