Instances of this class split up config files.

Public Member Functions
	DtVrfConfigurationFileComposer ()

virtual	~DtVrfConfigurationFileComposer ()

virtual bool	init ()

virtual bool	readObjectMap (const DtFilename &objectMap)

virtual bool	readObjectMapFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &objectMap)

virtual std::set < DtSimulationAddress >	scenarioBackends () const

virtual DtBackendMap *	backendMap () const

virtual DtAddressMap *	objectMap () const

virtual const DtVrfFileParser *	fileParser () const

virtual bool	composeOrderOfBattleFile (const DtFilename &targetFileName, const DtList &files, DtString &sError, void *zf=0)

virtual bool	saveOrderOfBattleToZipFile (const DtFilename &targetFileName, const DtList &files, DtString &sError, void *zf=0)

virtual bool	saveOrderOfBattleToFile (const DtFilename &targetFileName, const DtList &files, DtString &sError)

virtual bool	composeScenarioScriptsFile (const DtFilename &targetFileName, const DtString &files, void *zf=0)

virtual bool	composeOrbatFile (const DtFilename &targetFileName, const DtString &files, void *zf=0)

virtual bool	composePlanFile (const DtFilename &targetFileName, const DtList &files, void *zf=0)

virtual bool	composeHostilityFile (const DtFilename &targetFileName, const DtList &files, void *zf=0)

virtual bool	composeScenarioExtrasFile (const DtFilename &targetFileName, const DtList &files, void *zf=0)

virtual bool	createMapFile (const DtFilename &targetFileName, const DtList &simAddresses, const DtList &oobFiles, const DtList &planFiles, bool preserveMappings=true, void *zf=0)

std::vector< DtFilename > &	customComponentAttachmentFilenames ()

const std::vector< DtFilename > &	customComponentAttachmentFilenames () const

virtual bool	decompose (const DtFilename &orderOfBattle, const DtFilename &plan, const DtFilename &globalPlan, bool &hasGlobalWeatherObject, bool &hasGlobalDynamicTerrainObject)

virtual bool	decomposeFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &orderOfBattle, const DtFilename &plan, const DtFilename &globalPlan, bool &hasGlobalWeatherObject, bool &hasGlobalDynamicTerrainObject)

virtual bool	decomposeScenarioScriptsFile (const DtFilename &)

virtual bool	decomposeScenarioScriptsFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &scriptsFile)

virtual bool	decomposeOrbatFile (const DtFilename &)

virtual bool	decomposeOrbatFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &orbatFile)

virtual bool	decomposeComponentAttachmentFile (const DtFilename &originalFile, unsigned numBackends)

virtual const DtFilename &	getComponentAttachmentFile (unsigned idx) const

virtual const DtFilename &	tempDirectory ()

virtual void	setTempDirectory (const DtFilename &f)

virtual void	setFilePrefix (const DtString &)

virtual const DtString &	filePrefix () const


virtual DtFilename *	getOrderOfBattleFile (const DtSimulationAddress &addr) const

virtual DtFilename *	getScenarioScriptsFile (const DtSimulationAddress &addr) const

virtual DtFilename *	getOrbatFile (const DtSimulationAddress &addr) const

virtual DtFilename *	getPlanFile (const DtSimulationAddress &addr) const

virtual DtFilename *	getGlobalPlanFile (const DtSimulationAddress &addr) const

Protected Types
typedef std::map < DtSimulationAddress, DtFilename * >	FilenameMap

Protected Member Functions
virtual bool	storeFileInZipFile (void *zf, const DtFilename &sourceFile, const DtFilename &destFile)

virtual bool	storeStringInZipFile (void *zf, const DtString &, const DtFilename &target)

virtual void	clear ()

virtual bool	createBackendFiles (const DtFilename &origFileName, FilenameMap &createdFiles, const char prefix="(\n", bool hasGlobalWeatherObject=0, bool *hasGlobalDynamicTerrainObject=0)

virtual bool	createBackendFilesFromZip (const DtFilename &zipFile, const DtFilename &origFileName, FilenameMap &createdFiles, const char prefix="(\n", bool hasGlobalWeatherObject=0, bool *hasGlobalDynamicTerrainObject=0)

virtual bool	finalizeBackendFilesParse (const DtFilename &origFileName, FilenameMap &createdFiles, const char prefix, bool hasGlobalWeatherObject, bool *hasGlobalDynamicTerrainObject=0)

virtual bool	composePlanFileBody (FILE *fp, const DtList &files)

virtual bool	composePlanFileBody (DtString &fp, const DtList &files)

virtual bool	fastProcess (const DtFilename &fullname, FILE fp, DtString returnBuffer, int &size)

virtual bool	fastProcessPlanFileBody (const DtFilename &fullname, FILE fp, DtString returnBuffer, int &size)

virtual void	cleanupFiles (FilenameMap &filenameMap)

Protected Attributes
DtBackendMap *	myBackendMap

DtAddressMap *	myObjectMap

DtAddressMap *	myOriginalObjectMap

DtVrfFileParser	myParser

FilenameMap	myAddr2FileMap

FilenameMap	myCreatedPlnFiles

FilenameMap	myCreatedOobFiles

FilenameMap	myCreatedGlobalPlanFiles

FilenameMap	myCreatedHostilityFiles

std::vector< DtFilename >	myCreatedComponentAttachmentFiles

DtFilename	myTempDirectory

std::vector< DtSimulationAddress >	myRequiredBackendAddrs

DtFilename *	myScenarioScriptsFile

DtFilename *	myOrbatFile

DtString	myFilePrefix

Static Protected Attributes
static DtUUID	theUnknownMappingName

Member Typedef Documentation

typedef std::map<DtSimulationAddress, DtFilename*> DtVrfConfigurationFileComposer::FilenameMap

protected

Constructor & Destructor Documentation

DtVrfConfigurationFileComposer::DtVrfConfigurationFileComposer ( )

Constructor.

virtual DtVrfConfigurationFileComposer::~DtVrfConfigurationFileComposer ( )

virtual

Destructor.

Member Function Documentation

virtual bool DtVrfConfigurationFileComposer::init ( )

virtual

initializes myObjectMap and myBackendMap

virtual bool DtVrfConfigurationFileComposer::readObjectMap ( const DtFilename & objectMap )

virtual

Reads the given object map into myObjectMap.

virtual bool DtVrfConfigurationFileComposer::readObjectMapFromZipFile	(	const DtFilename &	scenarioZipFile,
		const DtFilename &	objectMap
	)

virtual

virtual std::set<DtSimulationAddress> DtVrfConfigurationFileComposer::scenarioBackends ( ) const

virtual

Get a list of backends referenced in myObjectMap. Be sure to call readObjectMap() to initialize the map before calling this function.

virtual DtBackendMap* DtVrfConfigurationFileComposer::backendMap ( ) const

virtual

returns myBackendMap

virtual DtAddressMap* DtVrfConfigurationFileComposer::objectMap ( ) const

virtual

returns myObjectMap

virtual const DtVrfFileParser* DtVrfConfigurationFileComposer::fileParser ( ) const

virtual

virtual bool DtVrfConfigurationFileComposer::composeOrderOfBattleFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		DtString &	sError,
		void *	zf = `0`
	)

virtual

Concatenates all the order of battles files pointed to in the files DtList into one single file named targetFileName.

virtual bool DtVrfConfigurationFileComposer::saveOrderOfBattleToZipFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		DtString &	sError,
		void *	zf = `0`
	)

virtual

Saves the order of battle file information to the specified zip file.

virtual bool DtVrfConfigurationFileComposer::saveOrderOfBattleToFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		DtString &	sError
	)

virtual

virtual bool DtVrfConfigurationFileComposer::composeScenarioScriptsFile	(	const DtFilename &	targetFileName,
		const DtString &	files,
		void *	zf = `0`
	)

virtual

Concatenates all the scenario script files pointed to in the files DtList into one single file named targetFileName. Since there is only one scenario script file there will only be one file in the files list.

virtual bool DtVrfConfigurationFileComposer::composeOrbatFile	(	const DtFilename &	targetFileName,
		const DtString &	files,
		void *	zf = `0`
	)

virtual

Concatenates all the orbat files pointed to in the files DtList into one single file named targetFileName. Since there is only one orbat file there will only be one file in the files list.

virtual bool DtVrfConfigurationFileComposer::composePlanFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		void *	zf = `0`
	)

virtual

Concatenates all the plan files pointed to in the files DtList into one single file named targetFileName.

virtual bool DtVrfConfigurationFileComposer::composeHostilityFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		void *	zf = `0`
	)

virtual

Concatenates all the force hostility files pointed to in the files DtList into one single file named targetFileName.

virtual bool DtVrfConfigurationFileComposer::composeScenarioExtrasFile	(	const DtFilename &	targetFileName,
		const DtList &	files,
		void *	zf = `0`
	)

virtual

Concatenates all the force scenario-extras files pointed to in the files DtList into one single file named targetFileName.

virtual bool DtVrfConfigurationFileComposer::createMapFile	(	const DtFilename &	targetFileName,
		const DtList &	simAddresses,
		const DtList &	oobFiles,
		const DtList &	planFiles,
		bool	preserveMappings = `true`,
		void *	zf = `0`
	)

virtual

Creates a map file named targetFileName.

std::vector< DtFilename > & DtVrfConfigurationFileComposer::customComponentAttachmentFilenames ( )

inline

References myCreatedComponentAttachmentFiles.

const std::vector< DtFilename > & DtVrfConfigurationFileComposer::customComponentAttachmentFilenames ( ) const

inline

References myCreatedComponentAttachmentFiles.

virtual bool DtVrfConfigurationFileComposer::decompose	(	const DtFilename &	orderOfBattle,
		const DtFilename &	plan,
		const DtFilename &	globalPlan,
		bool &	hasGlobalWeatherObject,
		bool &	hasGlobalDynamicTerrainObject
	)

virtual

Decompose the given .oob and .pln files into separate files for each back-end based on the omp file. New files will be placed in the temporary directory specified by DtScenarioFileComposer::tempDirectory(). The names of the newly created files will be stored in hashlists which can be accessed later by getFiles() methods below. These lists will be cleared the next time decomposeScenario is called. Returns true upon success; false otherwise.

virtual bool DtVrfConfigurationFileComposer::decomposeFromZipFile	(	const DtFilename &	scenarioZipFile,
		const DtFilename &	orderOfBattle,
		const DtFilename &	plan,
		const DtFilename &	globalPlan,
		bool &	hasGlobalWeatherObject,
		bool &	hasGlobalDynamicTerrainObject
	)

virtual

virtual bool DtVrfConfigurationFileComposer::decomposeScenarioScriptsFile ( const DtFilename & )

virtual

Decomposes the scenario script file. Since there is only a single file this will simply create a file copy for each backend.

virtual bool DtVrfConfigurationFileComposer::decomposeScenarioScriptsFromZipFile	(	const DtFilename &	scenarioZipFile,
		const DtFilename &	scriptsFile
	)

virtual

virtual bool DtVrfConfigurationFileComposer::decomposeOrbatFile ( const DtFilename & )

virtual

Decomposes the orbat file. Since there is only a single file this will simply create a file copy for each backend.

virtual bool DtVrfConfigurationFileComposer::decomposeOrbatFromZipFile	(	const DtFilename &	scenarioZipFile,
		const DtFilename &	orbatFile
	)

virtual

virtual bool DtVrfConfigurationFileComposer::decomposeComponentAttachmentFile	(	const DtFilename &	originalFile,
		unsigned	numBackends
	)

virtual

Split the indicated component attachment file into separate temporary files, for distribution during scenario load.

virtual DtFilename* DtVrfConfigurationFileComposer::getOrderOfBattleFile ( const DtSimulationAddress & addr ) const

virtual