FBAssetFile Class Reference
Detailed Description
Class representing a file stored in a version control database.
Inheritance diagram for FBAssetFile:
Public Member Functions |
|
| __init__ (str pName, object pObject=None) | |
| Constructor. |
|
| IObject_Declare (Implementation) | |
| bool | FBCreate () |
| Open Reality Creation function. |
|
| bool | IsCheckedOut () |
| Returns a boolean value indicating if this
file is checked out by any user. |
|
| bool | IsCheckedOutByMe () |
| Returns a boolean value indicating if this
file is checked out by the current user. |
|
| str | GetCheckedOutBy () |
| Returns the name of the user who currently
has this file checked out. |
|
Member Function Documentation
Constructor.
- Parameters:
-
pName Name of Command. pObject Internal parent object to own FBComponent (default is NULL).
Reimplemented from FBAssetItem.
| IObject_Declare | ( | Implementation | ) |
Reimplemented from FBComponent.
| bool FBCreate | ( | ) |
Open Reality Creation function.
- Returns:
- Outcome of creation (true/false).
Reimplemented from FBComponent.
| bool IsCheckedOut | ( | ) |
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.
| bool IsCheckedOutByMe | ( | ) |
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.
| str GetCheckedOutBy | ( | ) |
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.
