ATSFileEntry Class Reference

This reference page is linked to from the following overview topics: Vault and Asset Tracking.

---

Search for all occurrences

---

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

#include <IATSProvider.h>

Inheritance diagram for ATSFileEntry:

List of all members.

Public Member Functions
ATSExport	ATSFileEntry ()
	Constructor.
virtual ATSExport	~ATSFileEntry ()
	Destructor.
virtual ATSExport const MCHAR *	GetFile ()
	Get file name.
virtual ATSExport void	SetFile (const MCHAR *szFile)
	Set file name.
virtual ATSExport ATSStatus	GetFlagsIn ()
	Get the In Flags for this file.
virtual ATSExport void	SetFlagsIn (ATSStatus dwFlagsIn)
	Set the In Flags for this file.
virtual ATSExport ATSClientPtr	GetClientPtr ()
	Get the client pointer associated with this file.
virtual ATSExport void	SetClientPtr (ATSClientPtr pClientPtr)
	Set the client pointer associated with this file.
virtual ATSExport ATSStatus	GetFlagsOut ()
	Get the Out Flags for this file.
virtual ATSExport void	SetFlagsOut (ATSStatus dwFlagsOut)
	Set the Out Flags for this file.
virtual ATSExport UINT	AddChild (ATSFileEntry *pEntry)
	Add child.
virtual ATSExport UINT	NumChildren ()
	Number of children.
virtual ATSExport ATSFileEntry *	GetChild (UINT iIndex)
	Get child.
virtual ATSExport bool	RemoveChild (UINT iIndex)
	Remove child.
virtual ATSExport bool	RemoveAllChildren ()
	Remove all child.
virtual ATSExport UINT	AddAttachment (const MCHAR *szFile, ATSFileEntry *pEntryParent=NULL, ATSStatus dwFlagsIn=ATS::kATSStatusActive, ATSClientPtr pClientPtr=NULL)
	Add attachment.
virtual ATSExport UINT	AddAttachment (ATSFileEntry *pEntry)
	Add attachment.
virtual ATSExport UINT	NumAttachments ()
	Number of attachments.
virtual ATSExport ATSFileEntry *	GetAttachment (UINT iIndex)
	Get attachment.
virtual ATSExport bool	RemoveAttachment (UINT iIndex)
	Remove attachment.
virtual ATSExport bool	RemoveAllAttachments ()
	Remove all attachments.
virtual ATSExport void	SetParent (ATSFileEntry *pParent)
	Set parent.
virtual ATSExport ATSFileEntry *	GetParent ()
	Get parent.
Protected Attributes
ATSString	mFile
ATSStatus	mFlagsIn
ATSStatus	mFlagsOut
ATSClientPtr	mClientPtr
std::vector< ATSFileEntry * >	mChildren
ATSFileEntry *	mpParent
std::vector< ATSFileEntry * >	mAttachments

---

Constructor & Destructor Documentation

ATSExport ATSFileEntry

(

)

Constructor.

virtual ATSExport ~ATSFileEntry

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual ATSExport const MCHAR* GetFile

(

)

[virtual]

Search for all occurrences

Get file name.

Returns:

string containing the filename

virtual ATSExport void SetFile

(

const MCHAR *

szFile

)

[virtual]

Search for all occurrences

Set file name.

Parameters:

[in]

szFile

string containing the filename

virtual ATSExport ATSStatus GetFlagsIn

(

)

[virtual]

Search for all occurrences

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)

virtual ATSExport void SetFlagsIn

(

ATSStatus

dwFlagsIn

)

[virtual]

Search for all occurrences

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]

dwFlagsIn

In flags

virtual ATSExport ATSClientPtr GetClientPtr

(

)

[virtual]

Search for all occurrences

Get the client pointer associated with this file.

Client pointer specified for this file

Returns:

client pointer (ATSClientPtr)

virtual ATSExport void SetClientPtr

(

ATSClientPtr

pClientPtr

)

[virtual]

Search for all occurrences

Set the client pointer associated with this file.

Parameters:

[in]

pClientPtr

client pointer

virtual ATSExport ATSStatus GetFlagsOut

(

)

[virtual]

Search for all occurrences

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

virtual ATSExport void SetFlagsOut

(

ATSStatus

dwFlagsOut

)

[virtual]

Search for all occurrences

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]

dwFlagsOut

Out flags (ATSStatus)

virtual ATSExport UINT AddChild

(

ATSFileEntry *

pEntry

)

[virtual]

Search for all occurrences

Add child.

Parameters:

[in]

pEntry

Pointer to ATSFileEntry object to add as child

Returns:

New number of children

virtual ATSExport UINT NumChildren

(

)

[virtual]

Search for all occurrences

Number of children.

Returns:

Number of children

virtual ATSExport ATSFileEntry* GetChild

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Get child.

Parameters:

[in]

iIndex

0-based index of child

Returns:

pointer to ATSFileEntry object

virtual ATSExport bool RemoveChild

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Remove child.

Parameters:

[in]

iIndex

0-based index of child

Returns:

true if success, false if failure

virtual ATSExport bool RemoveAllChildren

(

)

[virtual]

Search for all occurrences

Remove all child.

Returns:

true if success, false if failure

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

Search for all occurrences

Add attachment.

Parameters:

[in]	szFile	string that contains file name
[in]	pEntryParent	default is NULL. Pointer to parent ATSFileEntry object
[in]	dwFlagsIn	default is kATSStatusActive. ATSStatus value that specified initial In flags.
[in]	pClientPtr	default is NULL. Client defined pointer.

Returns:

New number of attachments

virtual ATSExport UINT AddAttachment

(

ATSFileEntry *

pEntry

)

[virtual]

Search for all occurrences

Add attachment.

Parameters:

[in]

pEntry

Pointer to ATSFileEntry object to add as an attachment. ATSFileEntry object will be copied.

Returns:

New number of attachments

virtual ATSExport UINT NumAttachments

(

)

[virtual]

Search for all occurrences

Number of attachments.

Returns:

number of attachments

virtual ATSExport ATSFileEntry* GetAttachment

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Get attachment.

Parameters:

[in]

iIndex

0-based index of attachment

Returns:

pointer to ATSFileEntry object

virtual ATSExport bool RemoveAttachment

(

UINT

iIndex

)

[virtual]

Search for all occurrences

Remove attachment.

Parameters:

[in]

iIndex

0-based index of attachment

Returns:

true if success, false if failure

virtual ATSExport bool RemoveAllAttachments

(

)

[virtual]

Search for all occurrences

Remove all attachments.

Returns:

true if success, false if failure

virtual ATSExport void SetParent

(

ATSFileEntry *

pParent

)

[virtual]

Search for all occurrences

Set parent.

Parameters:

[in]

pParent

Pointer to ATSFileEntry object to set as parent

virtual ATSExport ATSFileEntry* GetParent

(

)

[virtual]

Search for all occurrences

Get parent.

Returns:

Pointer to ATSFileEntry object

---

Member Data Documentation

ATSString mFile [protected]

Search for all occurrences

ATSStatus mFlagsIn [protected]

Search for all occurrences

ATSStatus mFlagsOut [protected]

Search for all occurrences

ATSClientPtr mClientPtr [protected]

Search for all occurrences

std::vector< ATSFileEntry* > mChildren [protected]

Search for all occurrences

ATSFileEntry* mpParent [protected]

Search for all occurrences

std::vector< ATSFileEntry* > mAttachments [protected]

Search for all occurrences