de::gsi::bel::value::ValueModel

de::gsi::bel::value::ValueModel Interface Reference

Inheritance diagram for de::gsi::bel::value::ValueModel:

de::gsi::bel::value::ValueModelImpl List of all members.

Public Member Functions

abstract String getHost ()
abstract int getPort ()
abstract String toString ()
abstract void addValueListener (ValueListener l)
abstract void removeValueListener (ValueListener l)
abstract void close () throws IOException
abstract int unsubscribe (String[] adr, Object userObject)
abstract int unsubscribe (String adr, Object userObject)
abstract int subscribe (String[] adr, double tolerance, Object userObject)
abstract int subscribe (String adr, double tolerance, Object userObject)
abstract int subscribe (String adr, Object userObject)
abstract int subscribe (String adr, String[] trigger, Object userObject)
abstract int unsubscribeSynch (String[] adr, int mSec)
abstract int unsubscribeSynch (String adr, int mSec)
abstract int subscribeSynch (String[] adr, double tolerance, int mSec)
abstract int subscribeSynch (String adr, double tolerance, int mSec)
abstract int subscribeSynch (String adr, int mSec)
abstract int subscribeSynch (String adr, String[] trigger, int mSec)
abstract int read (String adr, Object userObject)
abstract int write (de.gsi.bel.xfer.xvalue.Value_t value, Object userObject)
abstract int write (String adr, int arg, Object userObject)
abstract int write (String adr, boolean arg, Object userObject)
abstract int write (String adr, char arg, Object userObject)
abstract int write (String adr, double arg, Object userObject)
abstract int write (String adr, String arg, Object userObject)
abstract int rmFile (String filePath, Object userObject)
abstract int addFile (String path, File_t file, Object userObject)
abstract int pushFile (String path, File_t file, Object userObject)

Static Public Attributes

static final int REQUEST_FAILED = -1
static final int REQUEST_OK = 0

Detailed Description

Interface of the ValueModel The user of the model should supply and add listener objects to react to model requests. The information is given by the event parameters of the listener methods.

Author:
huhmann

Member Function Documentation

abstract int de::gsi::bel::value::ValueModel::addFile ( String  path,
File_t  file,
Object  userObject 
) [pure virtual]

Add a file to a folder

Parameters:
path The folder's path
file The file object to add to folder
userObject User object which can be retrieved when confirmation is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract void de::gsi::bel::value::ValueModel::addValueListener ( ValueListener  l  )  [pure virtual]

Add a listener to this value model.

Parameters:
l The listener to add to the models listener list.

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract void de::gsi::bel::value::ValueModel::close (  )  throws IOException [pure virtual]

Close the value model. We close the xfer connection and and call the closeHandler routines of all listeners.

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract String de::gsi::bel::value::ValueModel::getHost (  )  [pure virtual]

Retrieves host information of the value model's server

Returns:
Host

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::getPort (  )  [pure virtual]

Retrieves port information of the value model's server

Returns:
Port

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::pushFile ( String  path,
File_t  file,
Object  userObject 
) [pure virtual]

Add a file to a queue

Parameters:
path The queue's path
file The file object to add to queue
userObject User object which can be retrieved when confirmation is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::read ( String  adr,
Object  userObject 
) [pure virtual]

Read a file value from server.

Parameters:
adr File address.
userObject User object which can be retrieved when the result of read is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract void de::gsi::bel::value::ValueModel::removeValueListener ( ValueListener  l  )  [pure virtual]

Remove a listener from this value model.

Parameters:
l The listener to remove from the modells listener list.

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::rmFile ( String  filePath,
Object  userObject 
) [pure virtual]

Remove a file.

Parameters:
filePath The file's path
userObject User object which can be retrieved when confirmation is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribe ( String  adr,
String[]  trigger,
Object  userObject 
) [pure virtual]

Subscribe value model to service parameters.

Parameters:
adr File address we will subscribe for.
trigger Array of file addresses for which notifications will be send along with adr.
userObject User object which can be retrieved when confirmation of subscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribe ( String  adr,
Object  userObject 
) [pure virtual]

Subscribe value model to service parameter.

Parameters:
adr File address we will subscribe for.
userObject User object which can be retrieved when confirmation of subscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribe ( String  adr,
double  tolerance,
Object  userObject 
) [pure virtual]

Subscribe value model to service parameters.

Parameters:
adr File address we will subscribe for.
tolerance Tolerance of floating point file values. Changes inside this range will not cause a notification.
userObject User object which can be retrieved when confirmation of subscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribe ( String[]  adr,
double  tolerance,
Object  userObject 
) [pure virtual]

Subscribe value model to service parameters.

Parameters:
adr Array of file addresses we will subscribe for.
tolerance Tolerance of floating point file values. Changes inside this range will not cause a notification.
userObject User object which can be retrieved when confirmation of subscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribeSynch ( String  adr,
String[]  trigger,
int  mSec 
) [pure virtual]

Subscribe value model to service parameters. Synchronous mode.

Parameters:
adr File address we will subscribe for.
trigger Array of file addresses for which notifications will be send along with adr.
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribeSynch ( String  adr,
int  mSec 
) [pure virtual]

Subscribe value model to service parameter. Synchronous mode.

Parameters:
adr File address we will subscribe for.
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribeSynch ( String  adr,
double  tolerance,
int  mSec 
) [pure virtual]

Subscribe value model to service parameters. Synchronous mode.

Parameters:
adr File address we will subscribe for.
tolerance Tolerance of floating point file values. Changes inside this range will not cause a notification.
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::subscribeSynch ( String[]  adr,
double  tolerance,
int  mSec 
) [pure virtual]

Subscribe value model to service parameters. Synchronous mode.

Parameters:
adr Array of file addresses we will subscribe for.
tolerance Tolerance of floating point file values. Changes inside this range will not cause a notification.
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract String de::gsi::bel::value::ValueModel::toString (  )  [pure virtual]

Retrieves name and connection information of value model.

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::unsubscribe ( String  adr,
Object  userObject 
) [pure virtual]

Unsubscribe this value model from service-parameter.

Parameters:
adr File address we will unsubsribe.
userObject User object which can be retrieved when confirmation of unsubscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::unsubscribe ( String[]  adr,
Object  userObject 
) [pure virtual]

Unsubscribe this value model from service-parameters.

Parameters:
adr Array of file addresses we will unsubscribe
userObject User object which can be retrieved when confirmation of unsubscription is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::unsubscribeSynch ( String  adr,
int  mSec 
) [pure virtual]

Unsubscribe this value model from service-parameter. Synchronous mode.

Parameters:
adr File address we will unsubsribe.
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::unsubscribeSynch ( String[]  adr,
int  mSec 
) [pure virtual]

Unsubscribe this value model from service-parameters. Synchronous mode.

Parameters:
adr Array of file addresses we will unsubscribe
mSec timeout in milli seconds
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( String  adr,
String  arg,
Object  userObject 
) [pure virtual]

Write a String file value.

Parameters:
adr File address of parameter to write.
arg String value to write.
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( String  adr,
double  arg,
Object  userObject 
) [pure virtual]

Write a double file value.

Parameters:
adr File address of parameter to write.
arg Double value to write.
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( String  adr,
char  arg,
Object  userObject 
) [pure virtual]

Write a byte file value.

Parameters:
adr File address of parameter to write.
arg Byte value to write.
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( String  adr,
boolean  arg,
Object  userObject 
) [pure virtual]

Write a boolean file value.

Parameters:
adr File address of parameter to write.
arg The boolean value to write.
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( String  adr,
int  arg,
Object  userObject 
) [pure virtual]

Write a integer file value.

Parameters:
adr File address of parameter to write.
arg Integer value to write.
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

abstract int de::gsi::bel::value::ValueModel::write ( de.gsi.bel.xfer.xvalue.Value_t  value,
Object  userObject 
) [pure virtual]

Write a file value.

Parameters:
value Value to write (file address and value).
userObject User object which can be retrieved when confirmation of write is received.
Returns:

Implemented in de::gsi::bel::value::ValueModelImpl.

The documentation for this interface was generated from the following file:
Generated on 4 Mar 2014 for valuejava by  doxygen 1.4.7