Photomechanics API
Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport Class Referenceabstract

Represents physical turn table messages transport. Provides methods for send and receive messages. More...

Inheritance diagram for Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport:
[legend]

Public Member Functions

abstract void SendCommand (String command)
 Send given command string. Command begin and end inserted automatically; More...
 
abstract void StartListening ()
 Start listening for messages. More...
 
void Dispose ()
 

Public Attributes

const Char CommandBegin = '#'
 PC-to-turntable command begin character. More...
 
const Char CommandEnd = '.'
 PC-to-turntable command end character. More...
 

Protected Member Functions

virtual void Dispose (Boolean disposing)
 Standard Dispose pattern. More...
 
void RaiseMessageReceived (String message)
 Raise MessageReceived. More...
 
void ThrowIfDisposed ()
 Throws exception if transport is disposed. More...
 

Properties

Boolean IsDisposed [get]
 
- Properties inherited from Photomechanics.Photo3DStudio.Common.Interfaces.IDisposableExtended
Boolean IsDisposed [get]
 Determines whether the object is being disposed or already disposed and no longer functional. More...
 

Events

TypedEventHandler< MessagesTransport, String > MessageReceived
 Occurs when message is received. More...
 
TypedEventHandler< IDisposableExtendedDisposed
 Messages transport is disposing or disposed and no longer functional. More...
 
- Events inherited from Photomechanics.Photo3DStudio.Common.Interfaces.IDisposableExtended
TypedEventHandler< IDisposableExtendedDisposed
 Occurs when object is disposed. More...
 

Detailed Description

Represents physical turn table messages transport. Provides methods for send and receive messages.

This base class can be inherited in order to implement custom communication channel (for instance, if needed to control turntable that is connected to remote PC). The messages transport is then used by higher-level API's.

Member Function Documentation

◆ SendCommand()

abstract void Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.SendCommand ( String  command)
pure virtual

Send given command string. Command begin and end inserted automatically;

Implemented in Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.LegacyMftSerialMessagesTransport.

◆ StartListening()

abstract void Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.StartListening ( )
pure virtual

◆ Dispose()

virtual void Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.Dispose ( Boolean  disposing)
protectedvirtual

◆ RaiseMessageReceived()

void Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.RaiseMessageReceived ( String  message)
protected

◆ ThrowIfDisposed()

void Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.ThrowIfDisposed ( )
protected

Throws exception if transport is disposed.

Exceptions
ObjectDisposedException

Member Data Documentation

◆ CommandBegin

const Char Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.CommandBegin = '#'

PC-to-turntable command begin character.

◆ CommandEnd

const Char Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.CommandEnd = '.'

PC-to-turntable command end character.

Event Documentation

◆ MessageReceived

TypedEventHandler<MessagesTransport, String> Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.MessageReceived

Occurs when message is received.

◆ Disposed

TypedEventHandler<IDisposableExtended> Photomechanics.Photo3DStudio.TurntableControl.Legacy.Mft.MessagesTransport.Disposed

Messages transport is disposing or disposed and no longer functional.