Open Reality Reference Guide
fbdeck.h File Reference

Contains abstract deck class to interface with a deck. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

Go to the source code of this file.

Classes

class  FBDeck
 Interface to a tape deck. More...
 
class  FBPropertyListDeck
 PropertyList: Deck More...
 

Macros

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once... More...
 
#define FBRegisterDeck(UniqueNameStr, ClassName, Label, Description, IconFilename)
 Deck class registration. More...
 
#define FBDeckDeclare(ClassName)
 Deck class declaration. More...
 
#define FBDeckImplementation(ThisComponent)    FBClassImplementation( ThisComponent )
 Deck class implementation. More...
 

Enumerations

enum  FBDeckTransportMode {
  kFBDeckTransportNone,
  kFBDeckTransportSync,
  kFBDeckTransportSlave = kFBDeckTransportSync,
  kFBDeckTransportMain,
  kFBDeckTransportMaster = kFBDeckTransportMain
}
 FBDeckTransportMode. More...
 

Functions

 __FB_FORWARD (FBDeck)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, DeckTransportMode)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, Deck)
 

Detailed Description

Contains abstract deck class to interface with a deck.

Definition in file fbdeck.h.

Macro Definition Documentation

◆ FBDeckDeclare

#define FBDeckDeclare (   ClassName)
Value:
FBClassDeclare( ClassName,FBDeck ); \
public: \
ClassName(const char* pName):FBDeck(pName) { FBClassInit; } \
private:

Deck class declaration.

Parameters
ClassNameName of deck class.

Definition at line 85 of file fbdeck.h.

◆ FBDeckImplementation

#define FBDeckImplementation (   ThisComponent)     FBClassImplementation( ThisComponent )

Deck class implementation.

Parameters
ThisComponentClass to implement.

Definition at line 94 of file fbdeck.h.

◆ FBRegisterDeck

#define FBRegisterDeck (   UniqueNameStr,
  ClassName,
  Label,
  Description,
  IconFilename 
)
Value:
HIObject RegisterDeck##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
{ \
ClassName *Class = new ClassName(pName); \
Class->UniqueName = UniqueNameStr; \
if (Class->FBCreate()) { \
Class->ThreadSync(); \
return Class->GetHIObject(); \
} else { \
delete Class; \
return NULL; \
} \
} \
FBLibraryModule( ClassName ) \
{ \
FBRegisterObject( ClassName,"Decks",Label,Description,RegisterDeck##ClassName, true, IconFilename ); \
}

Deck class registration.

Parameters
UniqueNameStrUnique name of deck.
ClassNameName of deck class.
LabelShort description.
DescriptionLong description.
IconFilenameFilename of associated icon.

Definition at line 64 of file fbdeck.h.

◆ FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbdeck.h.

Enumeration Type Documentation

◆ FBDeckTransportMode

FBDeckTransportMode.

Enumerator
kFBDeckTransportNone 

No transport interaction.

kFBDeckTransportSync 

Sync to transport controls.

kFBDeckTransportSlave 
Deprecated:
Use kFBDeckTransportSync.
kFBDeckTransportMain 

Transport main.

kFBDeckTransportMaster 
Deprecated:
Use kFBDeckTransportMain.

Definition at line 104 of file fbdeck.h.

FBClassDeclare
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition: fbdefines.h:85
FBDeck
Interface to a tape deck.
Definition: fbdeck.h:116
FBClassInit
#define FBClassInit
Class initialization.
Definition: fbdefines.h:64