Public Member Functions

FBAssetFile Class Reference

Search for all occurrences

Detailed Description

Class representing a file stored in a version control database.

Definition at line 191 of file fbassetmng.h.

#include <fbassetmng.h>

Inheritance diagram for FBAssetFile:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBAssetFile (const char *pName, HIObject pObject=NULL)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
virtual bool FBCreate ()
 Open Reality Creation function.
virtual bool IsCheckedOut () const =0
 Returns a boolean value indicating if this file is checked out by any user.
virtual bool IsCheckedOutByMe () const =0
 Returns a boolean value indicating if this file is checked out by the current user.
virtual FBString GetCheckedOutBy () const =0
 Returns the name of the user who currently has this file checked out.

Constructor & Destructor Documentation

FBAssetFile ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of Command.
pObjectInternal parent object to own FBComponent (default is NULL).

Member Function Documentation

IObject_Declare ( K_IMPLEMENTATION  )
virtual bool FBCreate ( ) [virtual]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

virtual bool IsCheckedOut ( ) const [pure virtual]

Returns a boolean value indicating if this file is checked out by any user.

Returns:
A boolean value indicating if this node is checked out.
virtual bool IsCheckedOutByMe ( ) const [pure virtual]

Returns a boolean value indicating if this file is checked out by the current user.

Returns:
A boolean value indicating if this node is checked out by the current user.
virtual FBString GetCheckedOutBy ( ) const [pure virtual]

Returns the name of the user who currently has this file checked out.

Returns:
The user name if the file is checked out, or an empty string if it is not.

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

FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile
FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile FBAssetFile