Classes
class	Error
	The return state / error value of a Project function call. More...

class	Iterator
	Pointer to a project location. More...

class	Metadata
	Dictionary of values associated with an Iterator. More...

class	MetadataConst
	Constant (read-only) value of Metadata. More...

class	Output
	Subfolder of a Run, regrouping Results for a step. More...

class	Path
	Paths used for internal Project filesystem. More...

class	Project
	Base class for Project API, also see SimProject. More...

class	ProjectStoragePolicy
	Project storage settings, control folder management, folder names, etc. More...

class	Query
	Set of conditions used in search within the Project. See Iterator::find() More...

class	Result
	Result (data) file, output of a Simulation Run. More...

class	Run
	Subfolder of a Simulation, regrouping Output/Result for a step. More...

class	RunGroup
	Optional concept - Virtual folder with a list of Run. More...

class	RunOutputAttr
	Base class for Run, Output, Result - provide built-in variable set/get functions. More...

class	SimBase
	Base class for Run and Simulation - shared functions. More...

class	SimProject
	Main object for Simulation based projects. More...

class	Simulation
	Subfolder of a Project, regrouping input files and Run subfolders. More...

class	Storage
	Base class for file storage management module. More...

class	StorageFilesystem
	Class for Storage on standard filesystem, for file:// URL. More...

class	URL
	The address of a local or remote file, using the URI format. More...

Typedefs
typedef std::string	URLType

Enumerations
enum	PItemType { PIUndefined =0 , PIFolder =1 , PIFile =2 , PILink =3 , PIPropertyTree =4 }

Variables
Metadata	gDummyMeta

const std::string	sErrorNotOutputIterator = "Not an Output iterator"

const std::string	sErrorOutputInvalidFile = "Output - not a valid file"

const std::string	sErrorOutputInvalidSubclass = "Output - wrong subclass"

const std::string	sErrorNoCaseForOutput = "Cannot find case for output"

const std::string	sErrorNoVariable = "No such variable"

const std::string	sErrorNoMainDataType = "Output - MainDataType not defined"

const std::string	sErrorNoOutputOfType = "Output - No output of this type"

const std::string	sErrorMultipleOutputOfType = "Output - Multiple output of this type"

const std::string	sErrorNotResultIterator = "Not a Result iterator"

const std::string	sErrorResultInvalidFile = "Result - not a valid file"

const std::string	sErrorResultInvalidSubclass = "Result - wrong subclass"

const std::string	sErrorNoCaseForResult = "Cannot find case for result"

const std::string	sErrorNotRunIterator = "Not an Run iterator"

const std::string	sErrorRunInvalidFolder = "Run - not a valid file"

const std::string	sErrorRunInvalidSubclass = "Run - wrong subclass"

const std::string	sErrorInvalidOutputName = "Error in newOutput - invalid/unavailable name"

const std::string	sErrorNoTransient = "Not a transient run"

const std::string	sErrorNoTransientTime = "Transient run with no time variable"

const std::string	sErrorOutputType = "Output type error"

const std::string	sErrorNoCurrentOutput = "No current output"

const std::string	sErrorNotSimulationIterator = "Not an Simulation iterator"

const std::string	sErrorSimulationInvalidFolder = "Simulation - not a valid folder"

const std::string	sErrorSimulationInvalidSubclass = "Simulation - wrong subclass"

const std::string	sErrorSimulationNoRun = "Simulation - no such run"

const std::string	sErrorSimulationNoRunType = "Simulation - not a run"

const std::string	sErrorSimulationNoCurrentRun = "Simulation - no current run"

const std::string	sErrorSimulationNoRunGroup = "Simulation - no such run group"

const std::string	sErrorCreateRun = "Cannot create the new run subfolder"

const std::string	sErrorCreateRunGroup = "Cannot create the new run group subfolder"

const std::string	sErrorURLNotSupported = "URL type not supported"

static std::map< std::string, Storage * >	gStorageInterfaces

const int	sSHABufferSize = 1024*10

Typedef Documentation

◆ URLType

typedef std::string ansys::Project::URLType

Enumeration Type Documentation

◆ PItemType

enum ansys::Project::PItemType

Enumerator
PIUndefined
PIFolder
PIFile
PILink
PIPropertyTree

Variable Documentation

◆ gDummyMeta

Metadata ansys::Project::gDummyMeta

◆ gStorageInterfaces

std::map<std::string,Storage*> ansys::Project::gStorageInterfaces

static

◆ sErrorCreateRun

const std::string ansys::Project::sErrorCreateRun = "Cannot create the new run subfolder"

◆ sErrorCreateRunGroup

const std::string ansys::Project::sErrorCreateRunGroup = "Cannot create the new run group subfolder"

◆ sErrorInvalidOutputName

const std::string ansys::Project::sErrorInvalidOutputName = "Error in newOutput - invalid/unavailable name"

◆ sErrorMultipleOutputOfType

const std::string ansys::Project::sErrorMultipleOutputOfType = "Output - Multiple output of this type"

◆ sErrorNoCaseForOutput

const std::string ansys::Project::sErrorNoCaseForOutput = "Cannot find case for output"

◆ sErrorNoCaseForResult

const std::string ansys::Project::sErrorNoCaseForResult = "Cannot find case for result"

◆ sErrorNoCurrentOutput

const std::string ansys::Project::sErrorNoCurrentOutput = "No current output"

◆ sErrorNoMainDataType

const std::string ansys::Project::sErrorNoMainDataType = "Output - MainDataType not defined"

◆ sErrorNoOutputOfType

const std::string ansys::Project::sErrorNoOutputOfType = "Output - No output of this type"

◆ sErrorNotOutputIterator

const std::string ansys::Project::sErrorNotOutputIterator = "Not an Output iterator"

◆ sErrorNoTransient

const std::string ansys::Project::sErrorNoTransient = "Not a transient run"

◆ sErrorNoTransientTime

const std::string ansys::Project::sErrorNoTransientTime = "Transient run with no time variable"

◆ sErrorNotResultIterator

const std::string ansys::Project::sErrorNotResultIterator = "Not a Result iterator"

◆ sErrorNotRunIterator

const std::string ansys::Project::sErrorNotRunIterator = "Not an Run iterator"

◆ sErrorNotSimulationIterator

const std::string ansys::Project::sErrorNotSimulationIterator = "Not an Simulation iterator"

◆ sErrorNoVariable

const std::string ansys::Project::sErrorNoVariable = "No such variable"

◆ sErrorOutputInvalidFile

const std::string ansys::Project::sErrorOutputInvalidFile = "Output - not a valid file"

◆ sErrorOutputInvalidSubclass

const std::string ansys::Project::sErrorOutputInvalidSubclass = "Output - wrong subclass"

◆ sErrorOutputType

const std::string ansys::Project::sErrorOutputType = "Output type error"

◆ sErrorResultInvalidFile

const std::string ansys::Project::sErrorResultInvalidFile = "Result - not a valid file"

◆ sErrorResultInvalidSubclass

const std::string ansys::Project::sErrorResultInvalidSubclass = "Result - wrong subclass"

◆ sErrorRunInvalidFolder

const std::string ansys::Project::sErrorRunInvalidFolder = "Run - not a valid file"

◆ sErrorRunInvalidSubclass

const std::string ansys::Project::sErrorRunInvalidSubclass = "Run - wrong subclass"

◆ sErrorSimulationInvalidFolder

const std::string ansys::Project::sErrorSimulationInvalidFolder = "Simulation - not a valid folder"

◆ sErrorSimulationInvalidSubclass

const std::string ansys::Project::sErrorSimulationInvalidSubclass = "Simulation - wrong subclass"

◆ sErrorSimulationNoCurrentRun

const std::string ansys::Project::sErrorSimulationNoCurrentRun = "Simulation - no current run"

◆ sErrorSimulationNoRun

const std::string ansys::Project::sErrorSimulationNoRun = "Simulation - no such run"

◆ sErrorSimulationNoRunGroup

const std::string ansys::Project::sErrorSimulationNoRunGroup = "Simulation - no such run group"

◆ sErrorSimulationNoRunType

const std::string ansys::Project::sErrorSimulationNoRunType = "Simulation - not a run"

◆ sErrorURLNotSupported

const std::string ansys::Project::sErrorURLNotSupported = "URL type not supported"

◆ sSHABufferSize

const int ansys::Project::sSHABufferSize = 1024*10

ansys::Project Namespace Reference

Classes

Typedefs

Enumerations

Variables