Base Module  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FObject Class Reference

Implements FUnknown and IDependent. More...

#include <fobject.h>

+ Inheritance diagram for FObject:

Public Member Functions

 FObject ()
 default constructor... More...
 
 FObject (const FObject &)
 overloaded constructor... More...
 
virtual ~FObject ()
 destructor... More...
 
FObjectoperator= (const FObject &)
 overloads operator "=" as the reference assignment More...
 
virtual FClassID isA () const
 a local alternative to getFClassID () More...
 
virtual bool isA (FClassID s) const
 evaluates if the passed ID is of the FObject type More...
 
virtual bool isTypeOf (FClassID s, bool=true) const
 evaluates if the passed ID is of the FObject type More...
 
int32 getRefCount ()
 returns the current interface reference count More...
 
FUnknown * unknownCast ()
 get FUnknown interface from object More...
 
virtual tresult queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
 please refer to FUnknown::queryInterface () More...
 
virtual uint32 addRef () SMTG_OVERRIDE
 please refer to FUnknown::addref () More...
 
virtual uint32 release () SMTG_OVERRIDE
 please refer to FUnknown::release () More...
 
virtual void update (FUnknown *, int32) SMTG_OVERRIDE
 empty virtual method that should be overridden by derived classes for data updates upon changes More...
 
virtual void addDependent (IDependent *dep)
 adds dependency to the object More...
 
virtual void removeDependent (IDependent *dep)
 removes dependency from the object More...
 
virtual void changed (int32 msg=kChanged)
 Inform all dependents, that the object has changed. More...
 
virtual void deferUpdate (int32 msg=kChanged)
 Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). More...
 
virtual void updateDone (int32)
 empty virtual method that should be overridden by derived classes More...
 
virtual bool isEqualInstance (FUnknown *d)
 

Static Public Member Functions

static FClassID getFClassID ()
 return Class ID as an ASCII string (statically) More...
 
static void setUpdateHandler (IUpdateHandler *handler)
 set method for the local attribute More...
 
static IUpdateHandler * getUpdateHandler ()
 get method for the local attribute More...
 
static bool classIDsEqual (FClassID ci1, FClassID ci2)
 compares (evaluates) 2 class IDs More...
 
static FObjectunknownToObject (FUnknown *unknown)
 pointer conversion from FUnknown to FObject More...
 

Static Public Attributes

static const FUID iid
 Special UID that is used to cast an FUnknown pointer to a FObject. More...
 

Protected Attributes

int32 refCount
 COM-model local reference count. More...
 

Static Protected Attributes

static IUpdateHandler * gUpdateHandler = 0
 

Detailed Description

Implements FUnknown and IDependent.

FObject is a polymorphic class that implements IDependent (of SKI module) and therefore derived from FUnknown, which is the most abstract base class of all.

All COM-like virtual methods of FUnknown such as queryInterface(), addRef(), release() are implemented here. On top of that, dependency-related methods are implemented too.

Pointer casting is done via the template methods FCast, either FObject to FObject or FUnknown to FObject.

FObject supports a new singleton concept, therefore these objects are deleted automatically upon program termination.

  • Runtime type information: An object can be queried at runtime, of what class it is. To do this correctly, every class must override some methods. This is simplified by using the OBJ_METHODS macros
See also
  • FUnknown
  • IDependent
  • IUpdateHandler

Constructor & Destructor Documentation

FObject ( )
inline

default constructor...

FObject ( const FObject )
inline

overloaded constructor...

virtual ~FObject ( )
inlinevirtual

destructor...

Member Function Documentation

FObject& operator= ( const FObject )
inline

overloads operator "=" as the reference assignment

static FClassID getFClassID ( )
inlinestatic

return Class ID as an ASCII string (statically)

virtual FClassID isA ( ) const
inlinevirtual

a local alternative to getFClassID ()

virtual bool isA ( FClassID  s) const
inlinevirtual

evaluates if the passed ID is of the FObject type

virtual bool isTypeOf ( FClassID  s,
bool  = true 
) const
inlinevirtual

evaluates if the passed ID is of the FObject type

int32 getRefCount ( )
inline

returns the current interface reference count

FUnknown* unknownCast ( )
inline

get FUnknown interface from object

tresult queryInterface ( const TUID  _iid,
void **  obj 
)
virtual

please refer to FUnknown::queryInterface ()

uint32 addRef ( )
virtual

please refer to FUnknown::addref ()

uint32 release ( )
virtual

please refer to FUnknown::release ()

virtual void update ( FUnknown *  ,
int32   
)
inlinevirtual

empty virtual method that should be overridden by derived classes for data updates upon changes

void addDependent ( IDependent *  dep)
virtual

adds dependency to the object

void removeDependent ( IDependent *  dep)
virtual

removes dependency from the object

void changed ( int32  msg = kChanged)
virtual

Inform all dependents, that the object has changed.

void deferUpdate ( int32  msg = kChanged)
virtual

Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).

virtual void updateDone ( int32  )
inlinevirtual

empty virtual method that should be overridden by derived classes

virtual bool isEqualInstance ( FUnknown *  d)
inlinevirtual
static void setUpdateHandler ( IUpdateHandler *  handler)
inlinestatic

set method for the local attribute

static IUpdateHandler* getUpdateHandler ( )
inlinestatic

get method for the local attribute

bool classIDsEqual ( FClassID  ci1,
FClassID  ci2 
)
inlinestatic

compares (evaluates) 2 class IDs

FObject * unknownToObject ( FUnknown *  unknown)
inlinestatic

pointer conversion from FUnknown to FObject

Member Data Documentation

const FUID iid
static

Special UID that is used to cast an FUnknown pointer to a FObject.

int32 refCount
protected

COM-model local reference count.

IUpdateHandler * gUpdateHandler = 0
staticprotected
Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.