#ifndef _MFnReference
#define _MFnReference
//-
// ==========================================================================
// Copyright (C) 2012 Autodesk, Inc., and/or its licensors.  All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Autodesk, Inc. ("Autodesk") and/or its
// licensors,  which is protected by U.S. and Canadian federal copyright law
// and by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be
// copied or duplicated, in whole or in part, without the prior written
// consent of Autodesk.
//
// The copyright notices in the Software and this entire statement,
// including the above license grant, this restriction and the following
// disclaimer, must be included in all copies of the Software, in whole
// or in part, and all derivative works of the Software, unless such copies
// or derivative works are solely in the form of machine-executable object
// code generated by a source language processor.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
// AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED
// WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF
// NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
// OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO
// EVENT WILL AUTODESK AND/OR ITS LICENSORS BE LIABLE FOR ANY LOST
// REVENUES, DATA, OR PROFITS, OR SPECIAL, DIRECT, INDIRECT, OR
// CONSEQUENTIAL DAMAGES, EVEN IF AUTODESK AND/OR ITS LICENSORS HAS
// BEEN ADVISED OF THE POSSIBILITY OR PROBABILITY OF SUCH DAMAGES.
// ==========================================================================
//+
//
// CLASS:    MFnReference
//
// ****************************************************************************

#if defined __cplusplus

// ****************************************************************************
// INCLUDED HEADER FILES


#include <maya/MFnDependencyNode.h>


class MObject;
class MObjectArray;

// ****************************************************************************
// CLASS DECLARATION (MFnReference)

//! \ingroup OpenMaya MFn
//! \brief Function set for querying information about file references.
/*!
  
  Reference nodes are used to track data about file references. Referenced
  files may be loaded and unloaded. They also store data about changes
  made to objects in the referenced file. The class MItReferenceEdits may 
  be used to retrieve information about such changes.

  The class MFileIO may be used to perform actual operations on references
  such as loading, unloading, adding and removing references.

*/

class OPENMAYA_EXPORT MFnReference : public MFnDependencyNode
{
    declareMFn(MFnReference, MFnDependencyNode);

	MString 			fileName( bool resolvedName,
								  bool includePath,
								  bool includeCopyNumber,
								  MStatus* ReturnStatus = NULL ) const;
	MString 			associatedNamespace( bool shortName,
								   MStatus* ReturnStatus = NULL ) const;

	MString 			parentFileName( bool resolvedName,
										bool includePath,
										bool includeCopyNumber,
										MStatus* ReturnStatus = NULL ) const;
	MObject 			parentReference( MStatus* ReturnStatus = NULL ) const;
	MObject 			parentAssembly( MStatus* ReturnStatus = NULL ) const;

	bool 				containsNode( const MObject& node,
									  MStatus* ReturnStatus = NULL ) const;
	bool 				containsNodeExactly( const MObject& node,
											 MStatus* ReturnStatus = NULL ) const;
	void 				nodes( MObjectArray& nodes,
							   MStatus* ReturnStatus = NULL ) const;

	bool				isLoaded( MStatus* ReturnStatus = NULL ) const;
	bool				isLocked( MStatus* ReturnStatus = NULL ) const;
	bool				isExportEditsFile( MStatus* ReturnStatus = NULL ) const;		

public:

BEGIN_NO_SCRIPT_SUPPORT:
    declareMFnConstConstructor(MFnReference, MFnDependencyNode);
END_NO_SCRIPT_SUPPORT:
};

#endif /* __cplusplus */
#endif /* _MFnReference */