Public Member Functions

FBVisitor Class Reference

Search for all occurrences

Detailed Description

FBVisitor - abstract base class to retrieve contents of a FBUnion.

Each operator () returns a different type value to the user.

Definition at line 122 of file fbunion.h.

#include <fbunion.h>

List of all members.

Public Member Functions

virtual void operator() ()=0
 Handle NULL returned value from the FBUnion.
virtual void operator() (int &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (long long &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (unsigned long long &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (double &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (float &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (bool &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (FBTime const &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (const char *pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (HdlFBPlug const &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (FBVector2d const &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (FBVector3d const &pVal)=0
 Handle returned value from the FBUnion.
virtual void operator() (FBVector4d const &pVal)=0
 Handle returned value from the FBUnion.
virtual void BeginMap ()=0
 Handle returned map type stored in the FBUnion will be followed by N calls returning (const char *pName, FBUnion& pVal) returning the contents of the map item by item.
virtual void operator() (const char *pName, FBUnion const &pVal)=0
 Handle returned item stored in a map.
virtual void EndMap ()=0
 Indicate all map content is returned.
virtual void BeginArray ()=0
 Handle returned array type stored in the FBUnion will be followed by N calls returning (int Index, FBUnion) returning the contents of the array item by item.
virtual void operator() (int pIndex, FBUnion const &pVal)=0
 Handle returned item stored in an array.
virtual void EndArray ()=0
 Indicate all array content is returned.
virtual ~FBVisitor ()
 Virtual destructor to enable safe inheritance.

Constructor & Destructor Documentation

virtual ~FBVisitor ( ) [inline, virtual]

Virtual destructor to enable safe inheritance.

Definition at line 226 of file fbunion.h.

{ }

Member Function Documentation

virtual void operator() ( ) [pure virtual]

Handle NULL returned value from the FBUnion.

virtual void operator() ( int &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted int value from the FBUnion
virtual void operator() ( long long &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted int 64 value from the FBUnion
virtual void operator() ( unsigned long long &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted unsigned int 64 value from the FBUnion
virtual void operator() ( double &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted double value from the FBUnion
virtual void operator() ( float &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted float value from the FBUnion
virtual void operator() ( bool &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted bool value from the FBUnion
virtual void operator() ( FBTime const &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted FBTime value from the FBUnion
virtual void operator() ( const char *  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted String value from the FBUnion
virtual void operator() ( HdlFBPlug const &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted HdlFBPlug from the FBUnion Handle may possibly be null if the FBPlug has been deleted.
virtual void operator() ( FBVector2d const &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted FBVector2d value from the FBUnion
virtual void operator() ( FBVector3d const &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted FBVector3d value from the FBUnion
virtual void operator() ( FBVector4d const &  pVal) [pure virtual]

Handle returned value from the FBUnion.

Parameters:
pVal- extracted FBVector4d value from the FBUnion
virtual void BeginMap ( ) [pure virtual]

Handle returned map type stored in the FBUnion will be followed by N calls returning (const char *pName, FBUnion& pVal) returning the contents of the map item by item.

finally EndMap() is called to indicate all the contents of the map has been returned.

virtual void operator() ( const char *  pName,
FBUnion const &  pVal 
) [pure virtual]

Handle returned item stored in a map.

Parameters:
pName- key name of the item stored in the map
pVal- value of the item stored in the map, The value of the item returned is another FBUnion which can be Visited recursively to discover it's content
virtual void EndMap ( ) [pure virtual]

Indicate all map content is returned.

virtual void BeginArray ( ) [pure virtual]

Handle returned array type stored in the FBUnion will be followed by N calls returning (int Index, FBUnion) returning the contents of the array item by item.

finally EndArray() is called to indicate all the contents of the array has been returned.

virtual void operator() ( int  pIndex,
FBUnion const &  pVal 
) [pure virtual]

Handle returned item stored in an array.

Parameters:
pIndex- index of the item stored in the array
pVal- value of the item stored in the map, The value of the item returned is another FBUnion which can be Visited recursively to discover it's content
virtual void EndArray ( ) [pure virtual]

Indicate all array content is returned.


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

FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor
FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor FBVisitor