VACoreFactory.h

/*
 *  --------------------------------------------------------------------------------------------
 *
 *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
 *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
 *      VVV    VVV   AAA
 *       VVV  VVV     AAA        Copyright 2015-2017
 *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
 *         VVVV         AAA      RWTH Aachen University
 *
 *  --------------------------------------------------------------------------------------------
 */

#ifndef IW_VACORE_CORE_FACTORY
#define IW_VACORE_CORE_FACTORY

#include <VACoreDefinitions.h>
#include <VAStruct.h>

#ifndef VACORE_DEFAULT_CONFIGFILE
#define VACORE_DEFAULT_CONFIGFILE "\"VACore.ini\""
#endif // VACORE_DEFAULT_CONFIGFILE

// Foward declarations
class IVACore;

namespace VACore
{
	//! Factory method - creates a VACore instance
	/** 
	  * @input oArgs Arguments with configuration for the core
	  * @output Pointer to the core instance (VA interface API from VABase)
	  */
	VACORE_API IVACore* CreateCoreInstance( const CVAStruct& oArgs );

	//! Factore method - create a VACore instance with configuration file
	VACORE_API IVACore* CreateCoreInstance( const std::string& sConfigFile = VACORE_DEFAULT_CONFIGFILE );

	//! Returns the filesystem path of the VACore shared lib (e.g. VACore.dll)
	VACORE_API std::string GetCoreLibFilePath();

} // End of namespace "VACore"

#endif // IW_VACORE_CORE_FACTORY