HdlFBPlug Class Reference
 
 
 
HdlFBPlug Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014.


#include <fbplug.h>


Class Description

Handler of FBPlug object Use this handler object to gracefully take care of dangling pointer problem.

For example, you created FBCamera object and hold it's pointer address to further usage, However, this FBCamera object could be destroyed by the application internally at any moment and its pointer you currently hold is invalid. But you don't easy way to tell so. This HdlFBPlug class provide means to handle this case gracefully.

Definition at line 537 of file fbplug.h.

Inheritance diagram for HdlFBPlug:
HdlFBPlugTemplate< T >

Public Member Functions

  HdlFBPlug ()
  HdlFBPlug (const FBPlug *pFBPlug)
  HdlFBPlug (HdlFBPlug const &pFBPlug)
  ~HdlFBPlug ()
bool  Ok () const
bool  Is (int pTypeId)
  Is( int pTypeId )
HdlFBPlug operator= (const FBPlug *pFBPlug)
HdlFBPlug operator= (const HdlFBPlug &pFBPlug)
bool  operator== (const HdlFBPlug &pFBPlug) const
bool  operator!= (const HdlFBPlug &pFBPlug) const
FBPlug GetPlug () const
FBPlug operator() () const
FBPlug operator-> () const
  operator FBPlug * () const

Protected Member Functions

void  SetPlug (const FBPlug *pFBPlug)

Constructor & Destructor Documentation

HdlFBPlug::HdlFBPlug ( )
HdlFBPlug::HdlFBPlug ( const FBPlug pFBPlug )
HdlFBPlug::HdlFBPlug ( HdlFBPlug const &  pFBPlug )
HdlFBPlug::~HdlFBPlug ( )

Member Function Documentation

bool HdlFBPlug::Ok ( ) const
bool HdlFBPlug::Is ( int  pTypeId )

Is( int pTypeId )

Parameters:
pTypeId Type Identification.
Returns:
True if Plug is a Instance of pTypeId.
HdlFBPlug& HdlFBPlug::operator= ( const FBPlug pFBPlug )
HdlFBPlug& HdlFBPlug::operator= ( const HdlFBPlug pFBPlug )
bool HdlFBPlug::operator== ( const HdlFBPlug pFBPlug ) const
bool HdlFBPlug::operator!= ( const HdlFBPlug pFBPlug ) const
FBPlug* HdlFBPlug::GetPlug ( ) const
FBPlug* HdlFBPlug::operator() ( ) const [inline]

Reimplemented in HdlFBPlugTemplate< T >.

Definition at line 567 of file fbplug.h.

{ return GetPlug(); }
FBPlug* HdlFBPlug::operator-> ( ) const [inline]

Reimplemented in HdlFBPlugTemplate< T >.

Definition at line 568 of file fbplug.h.

{ return GetPlug(); }
HdlFBPlug::operator FBPlug * ( ) const [inline]

Definition at line 570 of file fbplug.h.

    { 
        return (FBPlug *)GetPlug(); 
    }
void HdlFBPlug::SetPlug ( const FBPlug pFBPlug ) [protected]

The documentation for this class was generated from the following file: