Control Center
Scripting Interface Documentation
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...

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 More...
 
String scenesToImport
 scenes which will be imported More...
 
String impVersions
 versions which will be imported More...
 
bool audio
 import the audio folder More...
 
bool database
 import the database folder More...
 
bool final
 import the final frame folder More...
 
bool envGroup
 import the groups at the environment level More...
 
bool jobGroup
 import the groups at the job level More...
 
bool sceneGroup
 import the groups at the scene level More...
 
bool envLibrary
 import the libraries at the environment level More...
 
bool jobLibrary
 import the libraries at the job level More...
 
bool sceneLibrary
 import the libraries at the scene level More...
 
bool envPalette
 import the palettes at the environment level More...
 
bool jobPalette
 import the palettes at the job level More...
 
bool scenePalette
 import the palettes at the scene level More...
 
bool other
 import other ( non-standard ) folders that are at scene level More...
 
bool element
 import elements More...
 
bool timing
 import timings More...
 
bool annotation
 import annotation More...
 
bool stage
 import stage folder More...
 
bool hard
 
bool hardLn
 
bool sym
 
bool copy
 
bool keepValidSym
 
bool ignoreValidSym
 
bool resolveSym
 
bool keepBrokenSym
 
bool ignoreBrokenSym
 

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::ImportData ( const String &  envName,
const String &  jobName,
const String &  path,
const String &  fileSystem,
QObject *   
)

◆ ~ImportData()

ImportData::~ImportData ( )

Member Function Documentation

◆ annotation()

bool ImportData::annotation ( ) const

◆ audio()

bool ImportData::audio ( ) const

◆ copy()

bool ImportData::copy ( ) const

◆ database()

bool ImportData::database ( ) const

◆ element()

bool ImportData::element ( ) const

◆ envGroup()

bool ImportData::envGroup ( ) const

◆ envLibrary()

bool ImportData::envLibrary ( ) const

◆ envName()

String ImportData::envName ( ) const

◆ envPalette()

bool ImportData::envPalette ( ) const

◆ fileSystem()

String ImportData::fileSystem ( ) const

◆ final()

bool ImportData::final ( ) const

◆ hard()

bool ImportData::hard ( ) const

◆ hardLn()

bool ImportData::hardLn ( ) const

◆ ignoreBrokenSym()

bool ImportData::ignoreBrokenSym ( ) const

◆ ignoreValidSym()

bool ImportData::ignoreValidSym ( ) const

◆ importJobName()

String ImportData::importJobName ( ) const

◆ impVersions()

String ImportData::impVersions ( ) const

◆ impVersionsList()

StringList ImportData::impVersionsList ( ) const

◆ jobGroup()

bool ImportData::jobGroup ( ) const

◆ jobLibrary()

bool ImportData::jobLibrary ( ) const

◆ jobName()

String ImportData::jobName ( ) const

◆ jobPalette()

bool ImportData::jobPalette ( ) const

◆ keepBrokenSym()

bool ImportData::keepBrokenSym ( ) const

◆ keepValidSym()

bool ImportData::keepValidSym ( ) const

◆ other()

bool ImportData::other ( ) const

◆ path()

String ImportData::path ( ) const

◆ resolveSym()

bool ImportData::resolveSym ( ) const

◆ sceneGroup()

bool ImportData::sceneGroup ( ) const

◆ sceneLibrary()

bool ImportData::sceneLibrary ( ) const

◆ scenePalette()

bool ImportData::scenePalette ( ) const

◆ scenesToImport()

String ImportData::scenesToImport ( ) const

◆ scenesToImportList()

StringList ImportData::scenesToImportList ( ) const

◆ setannotation()

void ImportData::setannotation ( bool  priority)

◆ setaudio()

void ImportData::setaudio ( bool  priority)

◆ setCopy()

void ImportData::setCopy ( bool  priority)

◆ setdatabase()

void ImportData::setdatabase ( bool  priority)

◆ setelement()

void ImportData::setelement ( bool  priority)

◆ setenvGroup()

void ImportData::setenvGroup ( bool  priority)

◆ setenvLibrary()

void ImportData::setenvLibrary ( bool  priority)

◆ setenvPalette()

void ImportData::setenvPalette ( bool  priority)

◆ setFileSystem()

void ImportData::setFileSystem ( const String &  fileSystem)

◆ setfinal()

void ImportData::setfinal ( bool  priority)

◆ setHard()

void ImportData::setHard ( bool  priority)

◆ setHardLn()

void ImportData::setHardLn ( bool  priority)

◆ setIgnoreBrokenSym()

void ImportData::setIgnoreBrokenSym ( bool  priority)

◆ setIgnoreValidSym()

void ImportData::setIgnoreValidSym ( bool  priority)

◆ setImportJobName()

void ImportData::setImportJobName ( const String &  fileSystem)

◆ setImpVersions()

void ImportData::setImpVersions ( const String &  vers)

◆ setjobGroup()

void ImportData::setjobGroup ( bool  priority)

◆ setjobLibrary()

void ImportData::setjobLibrary ( bool  priority)

◆ setjobPalette()

void ImportData::setjobPalette ( bool  priority)

◆ setKeepBrokenSym()

void ImportData::setKeepBrokenSym ( bool  priority)

◆ setKeepValidSym()

void ImportData::setKeepValidSym ( bool  priority)

◆ setother()

void ImportData::setother ( bool  priority)

◆ setResolveSym()

void ImportData::setResolveSym ( bool  priority)

◆ setsceneGroup()

void ImportData::setsceneGroup ( bool  priority)

◆ setsceneLibrary()

void ImportData::setsceneLibrary ( bool  priority)

◆ setscenePalette()

void ImportData::setscenePalette ( bool  priority)

◆ setScenesToImport()

void ImportData::setScenesToImport ( const String &  scenes)

◆ setstage()

void ImportData::setstage ( bool  priority)

◆ setSym()

void ImportData::setSym ( bool  priority)

◆ settiming()

void ImportData::settiming ( bool  priority)

◆ stage()

bool ImportData::stage ( ) const

◆ sym()

bool ImportData::sym ( ) const

◆ timing()

bool ImportData::timing ( ) const

Property Documentation

◆ annotation

bool ImportData::annotation
readwrite

import annotation

◆ audio

bool ImportData::audio
readwrite

import the audio folder

◆ copy

bool ImportData::copy
readwrite

◆ database

bool ImportData::database
readwrite

import the database folder

◆ element

bool ImportData::element
readwrite

import elements

◆ envGroup

bool ImportData::envGroup
readwrite

import the groups at the environment level

◆ envLibrary

bool ImportData::envLibrary
readwrite

import the libraries at the environment level

◆ envName

String ImportData::envName
read

◆ envPalette

bool ImportData::envPalette
readwrite

import the palettes at the environment level

◆ fileSystem

String ImportData::fileSystem
readwrite

◆ final

bool ImportData::final
readwrite

import the final frame folder

◆ hard

bool ImportData::hard
readwrite

◆ hardLn

bool ImportData::hardLn
readwrite

◆ ignoreBrokenSym

bool ImportData::ignoreBrokenSym
readwrite

◆ ignoreValidSym

bool ImportData::ignoreValidSym
readwrite

◆ importJobName

String ImportData::importJobName
readwrite

job from which scenes will be imported

◆ impVersions

String ImportData::impVersions
readwrite

versions which will be imported

◆ jobGroup

bool ImportData::jobGroup
readwrite

import the groups at the job level

◆ jobLibrary

bool ImportData::jobLibrary
readwrite

import the libraries at the job level

◆ jobName

String ImportData::jobName
read

◆ jobPalette

bool ImportData::jobPalette
readwrite

import the palettes at the job level

◆ keepBrokenSym

bool ImportData::keepBrokenSym
readwrite

◆ keepValidSym

bool ImportData::keepValidSym
readwrite

◆ other

bool ImportData::other
readwrite

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

◆ path

String ImportData::path
read

◆ resolveSym

bool ImportData::resolveSym
readwrite

◆ sceneGroup

bool ImportData::sceneGroup
readwrite

import the groups at the scene level

◆ sceneLibrary

bool ImportData::sceneLibrary
readwrite

import the libraries at the scene level

◆ scenePalette

bool ImportData::scenePalette
readwrite

import the palettes at the scene level

◆ scenesToImport

String ImportData::scenesToImport
readwrite

scenes which will be imported

◆ stage

bool ImportData::stage
readwrite

import stage folder

◆ sym

bool ImportData::sym
readwrite

◆ timing

bool ImportData::timing
readwrite

import timings