Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLFileInfo Class Reference

Used to set some information about the user and software that generated the scene. More...

#include <FileInfo.h>

Inheritance diagram for CSLFileInfo::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Used to set some information about the user and software that generated the scene.


Constructor & Destructor Documentation

CSLFileInfo::CSLFileInfo CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Parent Template
Returns:
an instance of CSLFileInfo

CSLFileInfo::~CSLFileInfo   [virtual]
 

Destructor


Member Function Documentation

char * CSLFileInfo::GetOriginator  
 

Returns the originating software

Returns:
Originating software or null if not available

char * CSLFileInfo::GetProjectName  
 

Returns the name of the project

Returns:
Name of the project or null if not available

char * CSLFileInfo::GetSaveDateTime  
 

Returns the save date time.

Returns:
Save date time

char * CSLFileInfo::GetUsername  
 

Returns the user name.

Returns:
Name of the user or null if not available

void CSLFileInfo::SetOriginator char *    in_szOriginator
 

Sets the originating software

Parameters:
in_szOriginator  Originating software
Returns:
void

void CSLFileInfo::SetProjectName char *    in_szProjectName
 

Sets the name of the project

Parameters:
in_szProjectName  Name of the project
Returns:
void

void CSLFileInfo::SetSaveDateTime char *    in_szSaveDateTime
 

Sets the save date time.

Parameters:
in_szSaveDateTime  Save date time
Returns:
void

void CSLFileInfo::SetUsername char *    in_szUserName
 

Sets the user name.

Parameters:
in_szUserName  Name of the user
Returns:
void

SI_Error CSLFileInfo::Synchronize   [virtual]
 

Update template with current information

Returns:
SI_Error Specify if we could update the information or not

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLFileInfo::Type   [virtual]
 

Returns the type of this template (FILE_INFO)

Returns:
ETemplateType The type of this template (FILE_INFO)

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.