CSLFileInfo Class Reference

#include <FileInfo.h>

Inheritance diagram for CSLFileInfo:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLFileInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLFileInfo ()
char *  GetOriginator ()
void  SetOriginator (char *in_szOriginator)
char *  GetProjectName ()
void  SetProjectName (char *in_szProjectName)
char *  GetUsername ()
void  SetUsername (char *in_szUserName)
char *  GetSaveDateTime ()
void  SetSaveDateTime (char *in_szSaveDateTime)
ETemplateType  Type ()
SI_Error  Synchronize ()

Detailed Description

Used to set some information about the user and software that generated the scene (see the SI_FileInfo template reference).

Constructor & Destructor Documentation

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

virtual ~CSLFileInfo (  )  [virtual]

Destructor

Member Function Documentation

char* GetOriginator (  ) 

Returns the originating software

Returns:
Originating software or null if not available

void SetOriginator ( char *  in_szOriginator  ) 

Sets the originating software

Parameters:
in_szOriginator  Originating software
Returns:
void

char* GetProjectName (  ) 

Returns the name of the project

Returns:
Name of the project or null if not available

void SetProjectName ( char *  in_szProjectName  ) 

Sets the name of the project

Parameters:
in_szProjectName  Name of the project
Returns:
void

char* GetUsername (  ) 

Returns the user name.

Returns:
Name of the user or null if not available

void SetUsername ( char *  in_szUserName  ) 

Sets the user name.

Parameters:
in_szUserName  Name of the user
Returns:
void

char* GetSaveDateTime (  ) 

Returns the save date time.

Returns:
Save date time

void SetSaveDateTime ( char *  in_szSaveDateTime  ) 

Sets the save date time.

Parameters:
in_szSaveDateTime  Save date time
Returns:
void

ETemplateType Type (  )  [virtual]

Returns the type of this template (FILE_INFO)

Returns:
ETemplateType The type of this template (FILE_INFO)

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Update template with current information

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

Reimplemented from CSLTemplate.

The documentation for this class was generated from the following file: