Muscle Java API: muscle::core::conduit::terminal::Terminal Class Reference

muscle::core::conduit::terminal::Terminal Class Reference

Inheritance diagram for muscle::core::conduit::terminal::Terminal:

muscle::core::kernel::Module muscle::util::concurrency::Disposable muscle::core::Portal muscle::util::concurrency::Disposable muscle::core::conduit::terminal::Sink< T extends Serializable >

List of all members.


Public Member Functions

 Terminal ()
Timestamp getSITime ()
void resetTime (Timestamp time)
void setIdentifier (PortalID id)
PortalID getIdentifier ()
void dispose ()
boolean isDisposed ()

Protected Member Functions

File getLocalFile (String infix)
boolean fileIsRelative ()

Detailed Description

A base class for Source and Sink
Author:
jborgdo1

Constructor & Destructor Documentation

muscle::core::conduit::terminal::Terminal::Terminal (  )  [inline]


Member Function Documentation

File muscle::core::conduit::terminal::Terminal::getLocalFile ( String  infix  )  [inline, protected]

Constructs a filename for the terminal. It does so by reading the "file" property. If the "relative" option is set to true, it will open the file relative to the MUSCLE temporary directory of the Terminal. If "suffix" is set, it will append that extension. If the parameter infix is not null, and "suffix" is not set, it will append the extension .dat.

The filename can thus take the following forms: file or file.suffix or file.infix.dat or file.infix.suffix or tmpdir/file etc.

Parameters:
infix the infix, if any to use between the filename and the suffix.

boolean muscle::core::conduit::terminal::Terminal::fileIsRelative (  )  [inline, protected]

Timestamp muscle::core::conduit::terminal::Terminal::getSITime (  )  [inline]

Implements muscle::core::Portal.

void muscle::core::conduit::terminal::Terminal::resetTime ( Timestamp  time  )  [inline]

Implements muscle::core::Portal.

void muscle::core::conduit::terminal::Terminal::setIdentifier ( PortalID  id  )  [inline]

PortalID muscle::core::conduit::terminal::Terminal::getIdentifier (  )  [inline]

void muscle::core::conduit::terminal::Terminal::dispose (  )  [inline]

Dispose of the current object. After the first call, any following call is a no-op.

Implements muscle::util::concurrency::Disposable.

boolean muscle::core::conduit::terminal::Terminal::isDisposed (  )  [inline]

Whether the current object has been disposed of.

Implements muscle::util::concurrency::Disposable.


Generated on Thu Oct 18 14:28:29 2012 for Muscle Java API by  doxygen 1.5.6