ImportData Class Reference

ImportData defines the parameters for a database import command. More...

Public Member Functions
	ImportData (const String &envName, const String &jobName, const String &path, const String &fileSystem)
	Defines an Import job object. More...

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...
String	impDescription
	Description will be saved. 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
ControlCentre.importScene( data );

Constructor & Destructor Documentation

ImportData()

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

Defines an Import job object.

Parameters

envName	name of env
jobName	name of job
path	path to archive
fileSystem	filesystem on which import scene will reside

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

impDescription

String ImportData::impDescription

readwrite

Description will be saved.

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