Public Member Functions | Protected Member Functions | Protected Attributes

FbxIOBase Class Reference

Search for all occurrences

Detailed Description

Base class for FBX file importer and exporter.

Definition at line 32 of file fbxiobase.h.

#include <fbxiobase.h>

Inheritance diagram for FbxIOBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool  Initialize (const char *pFileName)
  Initializes the object.
virtual FbxString  GetFileName ()
  Returns the file name.

Protected Member Functions

  FbxIOBase (FbxManager &pManager, char const *pName)
int  DetectReaderFileFormat (const char *pFileName)
int  DetectWriterFileFormat (const char *pFileName)

Protected Attributes

FbxError  mError
FbxString  mFilename
FbxManager mManager
FbxString  mMessage

Error Management

enum   EErrorCode {
  eFileCorrupted, eFileVersionNotSupportedYet, eFileVersionNotSupportedAnymore, eFileNotOpened,
  eFileNotCreated, eOutOfSpace, eUninitializedFileName, eUnknownError,
  eIndexOutOfRange, ePasswordError, eEmbeddedOutOfSpace, eErrorCount
}
 

Error identifiers.

More...
FbxError GetError ()
  Retrieves the error object.
EErrorCode  GetLastErrorID () const
  Returns the last error code.
const char *  GetLastErrorString () const
  Returns the last error string.
void  GetMessage (FbxString &pMessage) const
  Returns the warning message from the file Reader and Writer.

Member Enumeration Documentation

enum EErrorCode

Error identifiers.

  • eFileCorrupted
  • eFileVersionNotSupportedYet
  • eFileVersionNotSupportedAnymore
  • eFileNotOpened
  • eFileNotCreated
  • eOutOfSpace
  • eUninitializedFileName
  • eUnknownError
  • eIndexOutOfRange
  • ePasswordError
  • eEmbeddedOutOfSpace
Enumerator:
eFileCorrupted 
eFileVersionNotSupportedYet 
eFileVersionNotSupportedAnymore 
eFileNotOpened 
eFileNotCreated 
eOutOfSpace 
eUninitializedFileName 
eUnknownError 
eIndexOutOfRange 
ePasswordError 
eEmbeddedOutOfSpace 
eErrorCount 

Definition at line 72 of file fbxiobase.h.


Constructor & Destructor Documentation

FbxIOBase ( FbxManager pManager,
char const *  pName 
) [protected]

Member Function Documentation

virtual bool Initialize ( const char *  pFileName ) [virtual]

Initializes the object.

Parameters:
pFileName The name of the file to access.
Returns:
True if successful, returns false otherwise.
Remarks:
To identify the error, call FbxIOBase::GetLastErrorID().
virtual FbxString GetFileName ( ) [virtual]

Returns the file name.

Returns:
The file name or an empty string if no filename has been set.
FbxError& GetError ( )

Retrieves the error object.

Returns:
A reference to the error object.
EErrorCode GetLastErrorID ( ) const

Returns the last error code.

Returns:
The last error code.
Examples:
Common/Common.cxx.
const char* GetLastErrorString ( ) const

Returns the last error string.

Returns:
A textual description of the last error.
Examples:
Common/Common.cxx, ConvertScene/main.cxx, ExportDocument/main.cxx, and ExportScene05/main.cxx.
void GetMessage ( FbxString pMessage ) const

Returns the warning message from the file Reader and Writer.

Parameters:
pMessage The warning message.
int DetectReaderFileFormat ( const char *  pFileName ) [protected]
int DetectWriterFileFormat ( const char *  pFileName ) [protected]

Member Data Documentation

FbxError mError [protected]

Definition at line 123 of file fbxiobase.h.

FbxString mFilename [protected]

Definition at line 124 of file fbxiobase.h.

FbxManager* mManager [protected]

Definition at line 125 of file fbxiobase.h.

FbxString mMessage [protected]

Definition at line 126 of file fbxiobase.h.


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

FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase
FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase FbxIOBase