3ds Max C++ API Reference
ATSFileEntry Class Reference

ATS File Object. More...

#include <IATSProvider.h>

+ Inheritance diagram for ATSFileEntry:

Public Member Functions

ATSExport ATSFileEntry ()
 Constructor. More...
 
virtual ATSExport ~ATSFileEntry ()
 Destructor. More...
 
virtual ATSExport const MCHARGetFile ()
 Get file name. More...
 
virtual ATSExport void SetFile (const MCHAR *szFile)
 Set file name. More...
 
virtual ATSExport ATSStatus GetFlagsIn ()
 Get the In Flags for this file. More...
 
virtual ATSExport void SetFlagsIn (ATSStatus dwFlagsIn)
 Set the In Flags for this file. More...
 
virtual ATSExport ATSClientPtr GetClientPtr ()
 Get the client pointer associated with this file. More...
 
virtual ATSExport void SetClientPtr (ATSClientPtr pClientPtr)
 Set the client pointer associated with this file. More...
 
virtual ATSExport ATSStatus GetFlagsOut ()
 Get the Out Flags for this file. More...
 
virtual ATSExport void SetFlagsOut (ATSStatus dwFlagsOut)
 Set the Out Flags for this file. More...
 
virtual ATSExport UINT AddChild (ATSFileEntry *pEntry)
 Add child. More...
 
virtual ATSExport UINT NumChildren ()
 Number of children. More...
 
virtual ATSExport ATSFileEntryGetChild (UINT iIndex)
 Get child. More...
 
virtual ATSExport bool RemoveChild (UINT iIndex)
 Remove child. More...
 
virtual ATSExport bool RemoveAllChildren ()
 Remove all child. More...
 
virtual ATSExport UINT AddAttachment (const MCHAR *szFile, ATSFileEntry *pEntryParent=NULL, ATSStatus dwFlagsIn=ATS::kATSStatusActive, ATSClientPtr pClientPtr=NULL)
 Add attachment. More...
 
virtual ATSExport UINT AddAttachment (ATSFileEntry *pEntry)
 Add attachment. More...
 
virtual ATSExport UINT NumAttachments ()
 Number of attachments. More...
 
virtual ATSExport ATSFileEntryGetAttachment (UINT iIndex)
 Get attachment. More...
 
virtual ATSExport bool RemoveAttachment (UINT iIndex)
 Remove attachment. More...
 
virtual ATSExport bool RemoveAllAttachments ()
 Remove all attachments. More...
 
virtual ATSExport void SetParent (ATSFileEntry *pParent)
 Set parent. More...
 
virtual ATSExport ATSFileEntryGetParent ()
 Get parent. More...
 

Protected Attributes

ATSString mFile
 
ATSStatus mFlagsIn
 
ATSStatus mFlagsOut
 
ATSClientPtr mClientPtr
 
std::vector< ATSFileEntry * > mChildren
 
ATSFileEntrympParent
 
std::vector< ATSFileEntry * > mAttachments
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Detailed Description

ATS File Object.

ATSFileEntry describes a file monitored by the Asset Tracking System. It contains information about the status, children (or dependent) files, and any attachment files to this file. Children define the file dependency tree for a particular ATSFileEntry. Attachments do not define a hierarchy and are single entries associated with the ATSFileEntry. Attachments are not considered a dependency and are simply files associated with the ATSFileEntry.

See also
ATSFileList

Constructor & Destructor Documentation

◆ ATSFileEntry()

Constructor.

◆ ~ATSFileEntry()

virtual ATSExport ~ATSFileEntry ( )
virtual

Destructor.

Member Function Documentation

◆ GetFile()

virtual ATSExport const MCHAR* GetFile ( )
virtual

Get file name.

Returns
string containing the filename

◆ SetFile()

virtual ATSExport void SetFile ( const MCHAR szFile)
virtual

Set file name.

Parameters
[in]szFilestring containing the filename

◆ GetFlagsIn()

virtual ATSExport ATSStatus GetFlagsIn ( )
virtual

Get the In Flags for this file.

The In flags are typically used to select, activate, exclude, etc. an ATSFileEntry within a ATSFileList.

Returns
In flags (ATSStatus)

◆ SetFlagsIn()

virtual ATSExport void SetFlagsIn ( ATSStatus  dwFlagsIn)
virtual

Set the In Flags for this file.

The In flags are typically used to select, activate, exclude, etc. an ATSFileEntry within a ATSFileList.

Parameters
[in]dwFlagsInIn flags

◆ GetClientPtr()

virtual ATSExport ATSClientPtr GetClientPtr ( )
virtual

Get the client pointer associated with this file.

Client pointer specified for this file

Returns
client pointer (ATSClientPtr)

◆ SetClientPtr()

virtual ATSExport void SetClientPtr ( ATSClientPtr  pClientPtr)
virtual

Set the client pointer associated with this file.

Parameters
[in]pClientPtrclient pointer

◆ GetFlagsOut()

virtual ATSExport ATSStatus GetFlagsOut ( )
virtual

Get the Out Flags for this file.

The Out flags are typically set by an ATS Provider to specify the version control status of this file.

Returns
Out flags

◆ SetFlagsOut()

virtual ATSExport void SetFlagsOut ( ATSStatus  dwFlagsOut)
virtual

Set the Out Flags for this file.

The Out flags are typically set by an ATS Provider to specify the version control status of this file.

Parameters
[in]dwFlagsOutOut flags (ATSStatus)

◆ AddChild()

virtual ATSExport UINT AddChild ( ATSFileEntry pEntry)
virtual

Add child.

Parameters
[in]pEntryPointer to ATSFileEntry object to add as child
Returns
New number of children

◆ NumChildren()

virtual ATSExport UINT NumChildren ( )
virtual

Number of children.

Returns
Number of children

◆ GetChild()

virtual ATSExport ATSFileEntry* GetChild ( UINT  iIndex)
virtual

Get child.

Parameters
[in]iIndex0-based index of child
Returns
pointer to ATSFileEntry object

◆ RemoveChild()

virtual ATSExport bool RemoveChild ( UINT  iIndex)
virtual

Remove child.

Parameters
[in]iIndex0-based index of child
Returns
true if success, false if failure

◆ RemoveAllChildren()

virtual ATSExport bool RemoveAllChildren ( )
virtual

Remove all child.

Returns
true if success, false if failure

◆ AddAttachment() [1/2]

virtual ATSExport UINT AddAttachment ( const MCHAR szFile,
ATSFileEntry pEntryParent = NULL,
ATSStatus  dwFlagsIn = ATS::kATSStatusActive,
ATSClientPtr  pClientPtr = NULL 
)
virtual

Add attachment.

Parameters
[in]szFilestring that contains file name
[in]pEntryParentdefault is NULL. Pointer to parent ATSFileEntry object
[in]dwFlagsIndefault is kATSStatusActive. ATSStatus value that specified initial In flags.
[in]pClientPtrdefault is NULL. Client defined pointer.
Returns
New number of attachments

◆ AddAttachment() [2/2]

virtual ATSExport UINT AddAttachment ( ATSFileEntry pEntry)
virtual

Add attachment.

Parameters
[in]pEntryPointer to ATSFileEntry object to add as an attachment. ATSFileEntry object will be copied.
Returns
New number of attachments

◆ NumAttachments()

virtual ATSExport UINT NumAttachments ( )
virtual

Number of attachments.

Returns
number of attachments

◆ GetAttachment()

virtual ATSExport ATSFileEntry* GetAttachment ( UINT  iIndex)
virtual

Get attachment.

Parameters
[in]iIndex0-based index of attachment
Returns
pointer to ATSFileEntry object

◆ RemoveAttachment()

virtual ATSExport bool RemoveAttachment ( UINT  iIndex)
virtual

Remove attachment.

Parameters
[in]iIndex0-based index of attachment
Returns
true if success, false if failure

◆ RemoveAllAttachments()

virtual ATSExport bool RemoveAllAttachments ( )
virtual

Remove all attachments.

Returns
true if success, false if failure

◆ SetParent()

virtual ATSExport void SetParent ( ATSFileEntry pParent)
virtual

Set parent.

Parameters
[in]pParentPointer to ATSFileEntry object to set as parent

◆ GetParent()

virtual ATSExport ATSFileEntry* GetParent ( )
virtual

Get parent.

Returns
Pointer to ATSFileEntry object

Member Data Documentation

◆ mFile

ATSString mFile
protected

◆ mFlagsIn

ATSStatus mFlagsIn
protected

◆ mFlagsOut

ATSStatus mFlagsOut
protected

◆ mClientPtr

ATSClientPtr mClientPtr
protected

◆ mChildren

std::vector< ATSFileEntry* > mChildren
protected

◆ mpParent

ATSFileEntry* mpParent
protected

◆ mAttachments

std::vector< ATSFileEntry* > mAttachments
protected