DbScript
Public Member Functions | Properties | Private Attributes | List of all members
ImportData Class Reference

ImportData defines the parameters for a database import command. The ImportData is an object which is instantiated in the scripting environment. In order to execute an import action, call ControlCentre.importScene( importData). More...

#include <scriptimportexport.h>

Inheritance diagram for ImportData:
Inheritance graph
[legend]
Collaboration diagram for ImportData:
Collaboration graph
[legend]

Public Member Functions

 ImportData (const String &envName, const String &jobName, const String &path, const String &fileSystem, QObject *)
 
 ~ImportData ()
 
String path () const
 
String envName () const
 
String jobName () const
 
String importJobName () const
 
void setImportJobName (const String &fileSystem)
 
String scenesToImport () const
 
StringList scenesToImportList () const
 
void setScenesToImport (const String &scenes)
 
String impVersions () const
 
StringList impVersionsList () const
 
void setImpVersions (const String &vers)
 
bool audio () const
 
void setaudio (bool priority)
 
bool database () const
 
void setdatabase (bool priority)
 
bool final () const
 
void setfinal (bool priority)
 
bool envGroup () const
 
void setenvGroup (bool priority)
 
bool jobGroup () const
 
void setjobGroup (bool priority)
 
bool sceneGroup () const
 
void setsceneGroup (bool priority)
 
bool envLibrary () const
 
void setenvLibrary (bool priority)
 
bool jobLibrary () const
 
void setjobLibrary (bool priority)
 
bool sceneLibrary () const
 
void setsceneLibrary (bool priority)
 
bool envPalette () const
 
void setenvPalette (bool priority)
 
bool jobPalette () const
 
void setjobPalette (bool priority)
 
bool scenePalette () const
 
void setscenePalette (bool priority)
 
bool other () const
 
void setother (bool priority)
 
bool element () const
 
void setelement (bool priority)
 
bool timing () const
 
void settiming (bool priority)
 
bool annotation () const
 
void setannotation (bool priority)
 
bool stage () const
 
void setstage (bool priority)
 
bool hard () const
 
void setHard (bool priority)
 
bool hardLn () const
 
void setHardLn (bool priority)
 
bool sym () const
 
void setSym (bool priority)
 
bool copy () const
 
void setCopy (bool priority)
 
bool keepValidSym () const
 
void setKeepValidSym (bool priority)
 
bool ignoreValidSym () const
 
void setIgnoreValidSym (bool priority)
 
bool resolveSym () const
 
void setResolveSym (bool priority)
 
bool keepBrokenSym () const
 
void setKeepBrokenSym (bool priority)
 
bool ignoreBrokenSym () const
 
void setIgnoreBrokenSym (bool priority)
 
String fileSystem () const
 
void setFileSystem (const String &fileSystem)
 

Properties

String envName
 
String jobName
 
String path
 
String fileSystem
 
String importJobName
 job from which scenes will be imported
 
String scenesToImport
 scenes which will be imported
 
String impVersions
 versions which will be imported
 
bool audio
 import the audio folder
 
bool database
 import the database folder
 
bool final
 import the final frame folder
 
bool envGroup
 import the groups at the environment level
 
bool jobGroup
 import the groups at the job level
 
bool sceneGroup
 import the groups at the scene level
 
bool envLibrary
 import the libraries at the environment level
 
bool jobLibrary
 import the libraries at the job level
 
bool sceneLibrary
 import the libraries at the scene level
 
bool envPalette
 import the palettes at the environment level
 
bool jobPalette
 import the palettes at the job level
 
bool scenePalette
 import the palettes at the scene level
 
bool other
 import other ( non-standard ) folders that are at scene level
 
bool element
 import elements
 
bool timing
 import timings
 
bool annotation
 import annotation
 
bool stage
 import stage folder
 
bool hard
 
bool hardLn
 
bool sym
 
bool copy
 
bool keepValidSym
 
bool ignoreValidSym
 
bool resolveSym
 
bool keepBrokenSym
 
bool ignoreBrokenSym
 

Private Attributes

String _envName
 
String _jobName
 
String _path
 
String _importJobName
 
StringList _scenesToImport
 
StringList _impVersions
 
bool _audio
 
bool _database
 
bool _final
 
bool _envGroup
 
bool _jobGroup
 
bool _sceneGroup
 
bool _envLibrary
 
bool _jobLibrary
 
bool _sceneLibrary
 
bool _envPalette
 
bool _jobPalette
 
bool _scenePalette
 
bool _other
 
bool _element
 
bool _timing
 
bool _annotation
 
bool _stage
 
bool _hard
 
bool _hardLn
 
bool _sym
 
bool _copy
 
bool _keepValidSym
 
bool _ignoreValidSym
 
bool _resolveSym
 
bool _keepBrokenSym
 
bool _ignoreBrokenSym
 
String _fileSystem
 

Detailed Description

ImportData defines the parameters for a database import command. The ImportData is an object which is instantiated in the scripting environment. In order to execute an import action, call ControlCentre.importScene( importData).

var job = new Job("envName", "jobName");
var data = new ImportData( job.envName, job.name, // envName and jobName where scene will be imported
"/home/user/importDir", // path to the package where IEContents.dat resides
"/USADATA"); // filesystem on which we will import
data.impVersions = ("1,2"); // If specified, only import these versions. If nothing specified,
// all versions in package will be imported

Constructor & Destructor Documentation

ImportData::ImportData ( const String &  envName,
const String &  jobName,
const String &  path,
const String &  fileSystem,
QObject *   
)
ImportData::~ImportData ( )

Member Function Documentation

bool ImportData::annotation ( ) const
bool ImportData::audio ( ) const
bool ImportData::copy ( ) const
bool ImportData::database ( ) const
bool ImportData::element ( ) const
bool ImportData::envGroup ( ) const
bool ImportData::envLibrary ( ) const
String ImportData::envName ( ) const
bool ImportData::envPalette ( ) const
String ImportData::fileSystem ( ) const
bool ImportData::final ( ) const
bool ImportData::hard ( ) const
bool ImportData::hardLn ( ) const
bool ImportData::ignoreBrokenSym ( ) const
bool ImportData::ignoreValidSym ( ) const
String ImportData::importJobName ( ) const
String ImportData::impVersions ( ) const
StringList ImportData::impVersionsList ( ) const
bool ImportData::jobGroup ( ) const
bool ImportData::jobLibrary ( ) const
String ImportData::jobName ( ) const
bool ImportData::jobPalette ( ) const
bool ImportData::keepBrokenSym ( ) const
bool ImportData::keepValidSym ( ) const
bool ImportData::other ( ) const
String ImportData::path ( ) const
bool ImportData::resolveSym ( ) const
bool ImportData::sceneGroup ( ) const
bool ImportData::sceneLibrary ( ) const
bool ImportData::scenePalette ( ) const
String ImportData::scenesToImport ( ) const
StringList ImportData::scenesToImportList ( ) const
void ImportData::setannotation ( bool  priority)
void ImportData::setaudio ( bool  priority)
void ImportData::setCopy ( bool  priority)
void ImportData::setdatabase ( bool  priority)
void ImportData::setelement ( bool  priority)
void ImportData::setenvGroup ( bool  priority)
void ImportData::setenvLibrary ( bool  priority)
void ImportData::setenvPalette ( bool  priority)
void ImportData::setFileSystem ( const String &  fileSystem)
void ImportData::setfinal ( bool  priority)
void ImportData::setHard ( bool  priority)
void ImportData::setHardLn ( bool  priority)
void ImportData::setIgnoreBrokenSym ( bool  priority)
void ImportData::setIgnoreValidSym ( bool  priority)
void ImportData::setImportJobName ( const String &  fileSystem)
void ImportData::setImpVersions ( const String &  vers)
void ImportData::setjobGroup ( bool  priority)
void ImportData::setjobLibrary ( bool  priority)
void ImportData::setjobPalette ( bool  priority)
void ImportData::setKeepBrokenSym ( bool  priority)
void ImportData::setKeepValidSym ( bool  priority)
void ImportData::setother ( bool  priority)
void ImportData::setResolveSym ( bool  priority)
void ImportData::setsceneGroup ( bool  priority)
void ImportData::setsceneLibrary ( bool  priority)
void ImportData::setscenePalette ( bool  priority)
void ImportData::setScenesToImport ( const String &  scenes)
void ImportData::setstage ( bool  priority)
void ImportData::setSym ( bool  priority)
void ImportData::settiming ( bool  priority)
bool ImportData::stage ( ) const
bool ImportData::sym ( ) const
bool ImportData::timing ( ) const

Member Data Documentation

bool ImportData::_annotation
private
bool ImportData::_audio
private
bool ImportData::_copy
private
bool ImportData::_database
private
bool ImportData::_element
private
bool ImportData::_envGroup
private
bool ImportData::_envLibrary
private
String ImportData::_envName
private
bool ImportData::_envPalette
private
String ImportData::_fileSystem
private
bool ImportData::_final
private
bool ImportData::_hard
private
bool ImportData::_hardLn
private
bool ImportData::_ignoreBrokenSym
private
bool ImportData::_ignoreValidSym
private
String ImportData::_importJobName
private
StringList ImportData::_impVersions
private
bool ImportData::_jobGroup
private
bool ImportData::_jobLibrary
private
String ImportData::_jobName
private
bool ImportData::_jobPalette
private
bool ImportData::_keepBrokenSym
private
bool ImportData::_keepValidSym
private
bool ImportData::_other
private
String ImportData::_path
private
bool ImportData::_resolveSym
private
bool ImportData::_sceneGroup
private
bool ImportData::_sceneLibrary
private
bool ImportData::_scenePalette
private
StringList ImportData::_scenesToImport
private
bool ImportData::_stage
private
bool ImportData::_sym
private
bool ImportData::_timing
private

Property Documentation

bool ImportData::annotation
readwrite

import annotation

bool ImportData::audio
readwrite

import the audio folder

bool ImportData::copy
readwrite
bool ImportData::database
readwrite

import the database folder

bool ImportData::element
readwrite

import elements

bool ImportData::envGroup
readwrite

import the groups at the environment level

bool ImportData::envLibrary
readwrite

import the libraries at the environment level

String ImportData::envName
read
bool ImportData::envPalette
readwrite

import the palettes at the environment level

String ImportData::fileSystem
readwrite
bool ImportData::final
readwrite

import the final frame folder

bool ImportData::hard
readwrite
bool ImportData::hardLn
readwrite
bool ImportData::ignoreBrokenSym
readwrite
bool ImportData::ignoreValidSym
readwrite
String ImportData::importJobName
readwrite

job from which scenes will be imported

String ImportData::impVersions
readwrite

versions which will be imported

bool ImportData::jobGroup
readwrite

import the groups at the job level

bool ImportData::jobLibrary
readwrite

import the libraries at the job level

String ImportData::jobName
read
bool ImportData::jobPalette
readwrite

import the palettes at the job level

bool ImportData::keepBrokenSym
readwrite
bool ImportData::keepValidSym
readwrite
bool ImportData::other
readwrite

import other ( non-standard ) folders that are at scene level

String ImportData::path
read
bool ImportData::resolveSym
readwrite
bool ImportData::sceneGroup
readwrite

import the groups at the scene level

bool ImportData::sceneLibrary
readwrite

import the libraries at the scene level

bool ImportData::scenePalette
readwrite

import the palettes at the scene level

String ImportData::scenesToImport
readwrite

scenes which will be imported

bool ImportData::stage
readwrite

import stage folder

bool ImportData::sym
readwrite
bool ImportData::timing
readwrite

import timings


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