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

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

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

Public Member Functions

void Dispose ()
 

Public Attributes

const Char CommandBegin = '#'
 PC-to-turntable command begin character. More...
 
const Char CommandEnd = '.'
 PC-to-turntable command end character. More...
 
const Char MessageBegin = '['
 Turntable-to-PC message begin character. More...
 
const Char MessageEnd = ']'
 Turntable-to-PC message end character. More...
 

Protected Member Functions

virtual void Dispose (Boolean disposing)
 Standard Dispose pattern. More...
 
void RaiseCharacterOutsideOfMessageReceived (Char ch)
 Raise CharacterOutsideOfMessageReceived. 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, Char > CharacterOutsideOfMessageReceived
 Occurs when received character that is not inside message (not preceded by message begin character). More...
 
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

◆ Dispose()

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

◆ RaiseCharacterOutsideOfMessageReceived()

void Photomechanics.Photo3DStudio.TurntableControl.Mft.MessagesTransport.RaiseCharacterOutsideOfMessageReceived ( Char  ch)
protected

◆ RaiseMessageReceived()

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

◆ ThrowIfDisposed()

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

Throws exception if transport is disposed.

Exceptions
ObjectDisposedException

Member Data Documentation

◆ CommandBegin

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

PC-to-turntable command begin character.

◆ CommandEnd

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

PC-to-turntable command end character.

◆ MessageBegin

const Char Photomechanics.Photo3DStudio.TurntableControl.Mft.MessagesTransport.MessageBegin = '['

Turntable-to-PC message begin character.

◆ MessageEnd

const Char Photomechanics.Photo3DStudio.TurntableControl.Mft.MessagesTransport.MessageEnd = ']'

Turntable-to-PC message end character.

Event Documentation

◆ CharacterOutsideOfMessageReceived

TypedEventHandler<MessagesTransport, Char> Photomechanics.Photo3DStudio.TurntableControl.Mft.MessagesTransport.CharacterOutsideOfMessageReceived

Occurs when received character that is not inside message (not preceded by message begin character).

◆ MessageReceived

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

Occurs when message is received.

◆ Disposed

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

Messages transport is disposing or disposed and no longer functional.