All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

ActionFlow Class CATVpmUsrActionFile

CATVpmUsrActionFile
 


public class CATVpmUsrActionFile


Constructor and Destructor Index


o CATVpmUsrActionFile()
Creates a file object for an action
o CATVpmUsrActionFile(CATVpmUsrActionFile&)
Copies an action affected file
o ~CATVpmUsrActionFile()

Method Index


o GetAccData()
Gets the access data
o GetAccMeth()
Gets the access method
o GetDescription()
Gets the description
o GetFlow()
Gets the flow
o GetFormat()
Gets the format of the file
o GetName()
Gets the name of the file in Blob mode
o GetTemporary()
Get the name of the file where the file is copied in blob mode
o SetAccMeth(CATUnicodeString&)
Set te acces method
o SetDescription(CATUnicodeString&)
Sets the description of the action affected file
o SetFlow(char)
Sets the flow of the action affected object param iFlow 'I' (input) or 'O' (output)
o SetFormat(CATUnicodeString&)
Sets the format of the action affected file
o SetName(CATUnicodeString&)
Sets the name of the file in Blob mode

Constructor and Destructor


o CATVpmUsrActionFile
public CATVpmUsrActionFile()
Creates a file object for an action
o CATVpmUsrActionFile
public CATVpmUsrActionFile( const CATVpmUsrActionFile& iFile)
Copies an action affected file
Parameters:
iFile
the file to copy
Returns:
the new file
o ~CATVpmUsrActionFile
public ~CATVpmUsrActionFile()

Methods


o GetAccData
public CATUnicodeString GetAccData()
Gets the access data
Returns:
  • File: path
  • Blob: action OID
o GetAccMeth
public CATUnicodeString GetAccMeth()
Gets the access method
Returns:
  • CATVpmUsrActionFileAccMeth_File: the file is just referenced
  • CATVpmUsrActionFileAccMeth_Blob: the file is saved is the database
o GetDescription
public CATUnicodeString GetDescription()
Gets the description
Returns:
The description of the object
o GetFlow
public char GetFlow()
Gets the flow
Returns:
'I' (input) or 'O' (output)
o GetFormat
public CATUnicodeString GetFormat()
Gets the format of the file
Returns:
the format of the file
o GetName
public CATUnicodeString GetName()
Gets the name of the file in Blob mode
Returns:
Name of the file
o GetTemporary
public CATUnicodeString GetTemporary()
Get the name of the file where the file is copied in blob mode
Returns:
name of the temporary file
o SetAccMeth
public void SetAccMeth( const CATUnicodeString& iAccMeth)
Set te acces method
Parameters:
iAccMeth
  • CATVpmUsrActionFileAccMeth_File: the file is just referenced
  • CATVpmUsrActionFileAccMeth_Blob: the file is saved is the database
o SetDescription
public void SetDescription( const CATUnicodeString& iDesc)
Sets the description of the action affected file
Parameters:
iDescription
The description of the action affected file
o SetFlow
public void SetFlow( const char iFlow)
Sets the flow of the action affected object param iFlow 'I' (input) or 'O' (output)
o SetFormat
public void SetFormat( const CATUnicodeString& iFormat)
Sets the format of the action affected file
Parameters:
iFormat
The format of the action affected file
o SetName
public void SetName( const CATUnicodeString& iName)
Sets the name of the file in Blob mode
Parameters:
iName
Name of the file

This object is included in the file: CATVpmUsrActionFile.h
If needed, your Imakefile.mk should include the module: ActionUsr

Copyright © 2003, Dassault Systèmes. All rights reserved.