MFileObject Class Reference
[OpenMaya - API module for common classes]

#include <MFileObject.h>

List of all members.


Detailed Description

Manipulate Unix filenames and search paths.

The MFileObject class implements an object that contains both a filename and a search path. The search path is specified by a single string in which multiple elements are separated by ':' characters. As well this string can contain Unix environment variables, specified as $VARNAME,

Filenames can be produced by the class by combining the path element with the filename element of the MFileObject. As well, methods are available to test for the existance of the files produced.

Examples:

animExportUtil.cpp, animExportUtil.h, animImportExport.cpp, animImportExport.h, cgfxFindImage.cpp, cgfxShaderNode.cpp, filteredAsciiFile.cpp, hlslShader.cpp, lepTranslator.cpp, maTranslator.cpp, objExport.cpp, polyExporter.cpp, and polyExporter.h.


Public Types

enum  MFileResolveMethod {
  kNone = (1<<0), kExact = (1<<1), kDirMap = (1<<2), kReferenceMappings = (1<<3),
  kRelative = (1<<4), kBaseName = (1<<5), kInputFile = kExact | kDirMap | kRelative | kBaseName, kInputReference = kInputFile | kReferenceMappings,
  kStrict = kExact | kDirMap
}
 Options to be used when resolving a file path. More...

Public Member Functions

 MFileObject ()
 MFileObject (const MFileObject &other)
virtual ~MFileObject ()
MFileObjectoperator= (const MFileObject &other)
MStatus setRawName (const MString &fileName)
MStatus setRawPath (const MString &filePath)
MStatus setRawFullName (const MString &fullFileName)
MStatus overrideResolvedFullName (const MString &fullFileName)
MString rawName () const
MString rawPath () const
MString rawFullName () const
MString expandedPath () const
MString expandedFullName () const
MString resolvedName () const
MString resolvedPath () const
MString resolvedFullName () const
unsigned int pathCount ()
MString ithPath (unsigned int index)
MString ithFullName (unsigned int index)
bool exists ()
bool exists (unsigned int index)
bool isSet () const
void setResolveMethod (MFileResolveMethod method)
MFileResolveMethod resolveMethod () const
MStatus setName (const MString &fileName)
 This method is obsolete.
MStatus setFullName (const MString &fileName)
 This method is obsolete.
MString name () const
 This method is obsolete.
MString path () const
 This method is obsolete.
MString fullName () const
 This method is obsolete.

Member Enumeration Documentation

Options to be used when resolving a file path.

Enumerator:
kNone  (Default) The resolved path is simply the first path after expanding any environment variables. Will not check if this file actually exists. User must explicitly check MFileObject::exists()
kExact  Checks if expanded paths exist. If paths are relative, assume it's relative to the current workspace (so check workspace current directory, file-rule directory and root directory
kDirMap  Checks path against mappings defined with the dirmap command. Only for absolute paths.
kReferenceMappings  Check path against any previously re-mapped reference locations. If kRelative/kBaseName are set, then even if we have an absolute path, convert to relative and/or baseName and look for them in directories provided to the missing reference dialog.
kRelative  Strips away the project directory, and treats path as relative. Relative to the current workspace, that is. So look in the workspace current directory, file-rules directory and the root directory
kBaseName  Strips away everything but the base file name and look in the current workspace.
kInputFile  Default on file open and import.
kInputReference  Default on file reference.
kStrict  Equivalent to the file -strict flag.


Constructor & Destructor Documentation

MFileObject::MFileObject (  ) 

Class constructor. Create a new MFileObject that contains neither a path nor a filename.

MFileObject::MFileObject ( const MFileObject other  ) 

Copy constructor. Create a new MFileObject instance and initialize it with the same path and filename as the given instance.

Parameters:
[in] other the MFileObject to copy

MFileObject::~MFileObject (  )  [virtual]

Class destructor.


Member Function Documentation

MFileObject & MFileObject::operator= ( const MFileObject other  ) 

Assignment operator. Allows assignment between MFileObjects.

MStatus MFileObject::setRawName ( const MString fileName  ) 

Set the unresolved filename element of the MFileObject instance. This name should not contain any '/' characters, it should indicate simply the name of a file. The directories in which this name will be searched for are specified by setRawPath.

Parameters:
[in] fileName An MString containing the filename.
Returns:
MS::kSuccess

MStatus MFileObject::setRawPath ( const MString pathName  ) 

Set the unresolved path element of the MFileObject instance. This should contain a list of directories, each separated by a single ':' character. The pathnames can contain Unix environment variables in the form $VARNAME. These will be expanded when paths to actual filenames are constructed.

Note that if the specified pathName is relative, contains environment variables, or does not exist, the paths returned by MFileObject::resolvedPath() and MFileObject::expandedPath() may not match the rawPath. See the description of MFileObject::resolvedPath() and MFileObject::expandedPath() for more information.

Parameters:
[in] pathName An MString containing the path string.
Returns:
MS::kSuccess

MStatus MFileObject::setRawFullName ( const MString fullFileName  ) 

This method combines the functions of the setRawName and setRawPath methods in that it sets both the path and filename from the given name.

If any '/' characters appear in the given name then the path element of the MFileObject is set to everything in name up to, but not including the last '/'. The filename is set to the part of name after the final '/'.

If no '/' characters appear in the given name then the path element is set to "." and the filename is set to the given name.

Note that if the specified fullFileName is relative, contains environment variables, or does not exist, the full names returned by MFileObject::resolvedFullName() and MFileObject::expandedFullName() may not match the fullFileName. See the description of MFileObject::resolvedFullName() and MFileObject::expandedFullName() for more information.

Parameters:
[in] fullFileName the string used to initialize the path and filename.
Returns:
MS::kSuccess
Examples:

MStatus MFileObject::overrideResolvedFullName ( const MString fullFileName  ) 

Normally when a raw file name is set, Maya will perform a series of operations on it in an attempt to resolve it to a valid file name. This final resolved file name can be accessed through the MFileObject::resolvedName(), MFileObject::resolvedPath(), and MFileObject::resolvedFullFileName() methods and can be quite different from the originally specified raw file name.

This method will override the normal Maya path resolution process and explicitly set the resolved file name. This path does not have to be a valid file path, but if any '/' characters appear in the given name then the resolved path element of the MFileObject is set to everything in name up to, but not including the last '/'. The resolved filename is set to the part of name after the final '/'.

Once the resolved file name is set, it is only guaranteed to be retained in the MFileObject so long as the raw file path is not updated. Once MFileObject::setRawPath(), MFileObject::setRawName(), or MFileObject::setRawFullName() is called, the normal Maya path resolution process will be re-invoked and the resolved path and filename will be updated.

Parameters:
[in] fullFileName the string used to override the path and filename.
Returns:
MS::kSuccess

MString MFileObject::rawName (  )  const

Returns the unresolved filename element of the MFileObject.

Returns:
An MString containing the filename.

MString MFileObject::rawPath (  )  const

Returns the path element of the MFileObject with all environment variables unexpanded.

Returns:
An MString containing the path.

MString MFileObject::rawFullName (  )  const

Returns the unrsolved full file name (path plus filename) of the MFileObject with all environment variables unexpanded.

Returns:
An MString containing the filename.

MString MFileObject::expandedPath (  )  const

Returns the path element of the MFileObject with all environment variables expanded.

After expanding environment variables Maya may perform additional modifications to the path in order to resolve it to a valid location on disk. This resolved path can be accessed through MFileObject::resolvedPath().

Returns:
An MString containing the path.

MString MFileObject::expandedFullName (  )  const

Returns the first pathname of a file constructed from the path and filename elements. All variables in the path element are expanded, and the first path (the part before the first ':' in the path) is prepended to the filename element to construct the fullName.

After expanding environment variables Maya may perform additional modifications to the full file name in order to resolve it to a valid location on disk. This resolved full file name can be accessed through MFileObject::resolvedFullName().

Returns:
An MString containing the filename.

MString MFileObject::resolvedName (  )  const

Returns the resolved filename element of the MFileObject.

Returns:
An MString containing the filename.

MString MFileObject::resolvedPath (  )  const

Returns the resolved path element of the MFileObject. In order to build the resolved path, Maya first expands all environment variables and then may perform additional modifications, such as prepending directories to a relative path name, in order to resolve the path to a valid location on disk.

Returns:
An MString containing the path.
Examples:

MString MFileObject::resolvedFullName (  )  const

Returns the first pathname of a file constructed from the path and filename elements. All variables in the path element are expanded, and the first path (the part before the first ':' in the path) is prepended to the filename element. After expanding all environment variables Maya may then perform additional modifications, such as prepending directories to a relative path name, in order to resolve the path to a valid location on disk.

Returns:
An MString containing the filename.

unsigned int MFileObject::pathCount (  ) 

Returns the number of paths in the path element of the MFileObject. This will be equal to one more than the number of ':' characters specified by the setRawPath method.

Returns:
An integer containing the number of path elements.

MString MFileObject::ithPath ( unsigned int  index  ) 

Returns the indicated portion of the path element of the MFileObject. All variables in the path element are expanded, and the portion indicated by the argument is extracted and returned.

Parameters:
[in] index the index of the desired path portion.
Returns:
An MString containing the path element.

MString MFileObject::ithFullName ( unsigned int  index  ) 

Returns the pathname of a file constructed from the indicated portion of the path element and filename element. All variables in the path element are expanded, and the indicated path portion is prepended to the filename element to construct the fullName.

Parameters:
[in] index the index of the desired path portion.
Returns:
An MString containing the pathname.

bool MFileObject::exists (  ) 

Checks to see if the file returned by the fullName method exists and is readable.

Returns:
Bool true if the file exists and is readable and false otherwise.

bool MFileObject::exists ( unsigned int  index  ) 

Checks to see if the file constructed from the indicated portion of the path element and filename element exists and is readble.

Returns:
Bool true if the file exists and is readable and false otherwise.

bool MFileObject::isSet (  )  const

Checks to see if both file and path elements of the MFileObject have been set.

Returns:
Bool true if both elements have been set and false otherwise.

void MFileObject::setResolveMethod ( MFileResolveMethod  method  ) 

Set the steps that should be used to resolve this file path.

MFileObject::MFileResolveMethod MFileObject::resolveMethod (  )  const

Returns the file-path resolution steps this object will use

Returns:
MFileResolveMethod resolution method

MStatus MFileObject::setName ( const MString fileName  ) 

This method is obsolete.

Deprecated:
Use the method MFileObject::setRawName instead.
Set the filename element of the MFileObject instance. This name should not contain any '/' characters, it should indicate simply the name of a file. The directories in which this name will be searched for are specified by setRawPath.

Parameters:
[in] fileName An MString containing the filename.
Returns:
MS::kSuccess

MStatus MFileObject::setFullName ( const MString fileName  ) 

This method is obsolete.

Deprecated:
Use the method MFileObject::setRawFullName instead.
This method combines the functions of the setName and setRawPath methods in that it sets both the path and filename from the given name.

If any '/' characters appear in the given name then the path element of the MFileObject is set to everything in name up to, but not including the last '/'. The filename is set to the part of name after the final '/'.

If no '/' characters appear in the given name then the path element is set to "." and the filename is set to the given name.

Parameters:
[in] fileName the string used to initialize the path and filename.
Returns:
MS::kSuccess

MString MFileObject::name (  )  const

This method is obsolete.

Deprecated:
Use the method MFileObject::resolvedName instead.
Returns the filename element of the MFileObject.

Returns:
An MString containing the filename.
Examples:

MString MFileObject::path (  )  const

This method is obsolete.

Deprecated:
Use the methods MFileObject::expandedPath or MFileObject::resolvedPath instead.
Returns the path element of the MFileObject with all environment variables expanded.

Returns:
An MString containing the path.
Examples:

MString MFileObject::fullName (  )  const

This method is obsolete.

Deprecated:
Use the methods MFileObject::expandedFullName or MFileObject::resolvedFullName instead.
Returns the first pathname of a file constructed from the path and filename elements. All variables in the path element are expanded, and the first path (the part before the first ':' in the path) is prepended to the filename element to construct the fullName.

Returns:
An MString containing the filename.
Examples:


Autodesk® Maya® 2010 © 1997-2009 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6