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

#include "RunOutputAttr.hpp"

Inheritance diagram for ansys::Project::RunOutputAttr:

Public Member Functions
virtual	~RunOutputAttr ()

virtual bool	hasValue (const std::string &pVar, bool pFlagInherited) const =0

virtual std::string	getValue (const std::string &pVar, bool pFlagInherited) const =0

virtual MetaVariableType	getValueType (const std::string &pVar, bool pFlagInherited) const =0

virtual void	setValue (const std::string &pVar, const std::string &pValue)=0

virtual int	getValueInt (const std::string &pVar, bool pFlagInherited) const =0

virtual double	getValueDouble (const std::string &pVar, bool pFlagInherited) const =0

virtual void	setValueInt (const std::string &pVar, int pValue)=0

virtual void	setValueDouble (const std::string &pVar, double pValue)=0

std::vector< std::string >	getValues (const std::vector< std::string > &pVars, bool pFlagInherited) const
	Returns the values for a list of variables. More...

int	getIndex () const
	Returns the output index (incremental id in a run) - always available. More...

int	getSolverIteration () const
	Returns the number of solver iterations (if available) More...

double	getTime () const
	Returns the transient time value (if available) More...

void	setIndex (int pValue)
	Changes the specified variable. More...

void	setSolverIteration (int pValue)
	Changes the specified variable. More...

void	setTime (double pValue)
	Changes the specified variable. More...

double	getCrankAngle () const
	Returns the specified variable (if available) More...

void	setCrankAngle (double pValue)
	Changes the specified variable. More...

int	getCaseId () const
	Returns the specified variable (if available) More...

int	getInputSettingsId () const
	Returns the specified variable (if available) More...

int	getDomainTransformationId () const
	Returns the specified variable (if available) More...

int	getPhysicsId () const
	Returns the specified variable (if available) More...

int	getOutputSettingsId () const
	Returns the specified variable (if available) More...

int	getMeshId () const
	Returns the specified variable (if available) More...

int	getTopologyId () const
	Returns the specified variable (if available) More...

int	getConnectivityId () const
	Returns the specified variable (if available) More...

int	getCoordinatesId () const
	Returns the specified variable (if available) More...

int	getLocationId () const
	Returns the specified variable (if available) More...

void	setCaseId (int pValue)
	Changes the specified variable. More...

void	setInputSettingsId (int pValue)
	Changes the specified variable. More...

void	setDomainTransformationId (int pValue)
	Changes the specified variable. More...

void	setPhysicsId (int pValue)
	Changes the specified variable. More...

void	setOutputSettingsId (int pValue)
	Changes the specified variable. More...

void	setMeshId (int pValue)
	Changes the specified variable. More...

void	setTopologyId (int pValue)
	Changes the specified variable. More...

void	setConnectivityId (int pValue)
	Changes the specified variable. More...

void	setCoordinatesId (int pValue)
	Changes the specified variable. More...

void	setLocationId (int pValue)
	Changes the specified variable. More...

Iterator	getFirstIteratorForCurrentCaseId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentPhysicsId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentInputSettingsId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentDomainTransformationId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentMeshId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentTopologyId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentConnectivityId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentCoordinatesId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrentLocationId () const
	See getFirstIterator(const std::string&) More...

Iterator	getFirstIteratorForCurrent (const std::string &pVar) const
	Return the first entry in the current Run, with same variable value. More...

Static Public Attributes
static const std::string	sVarTime

static const std::string	sVarSolverIteration

static const std::string	sVarIndex

static const std::string	sVarCrankAngle

static const std::string	sVarCaseId

static const std::string	sVarInputSettingsId

static const std::string	sVarDomainTransformationId

static const std::string	sVarPhysicsId

static const std::string	sVarOutputSettingsId

static const std::string	sVarMeshId

static const std::string	sVarTopologyId

static const std::string	sVarConnectivityId

static const std::string	sVarCoordinatesId

static const std::string	sVarLocationId

Protected Member Functions
virtual Iterator	getIterator () const =0

Detailed Description

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

The mandatory/built-in variables of a run are simple Metadata variables. The built-in variable should be accessed through the dedicated set/get API, the get API will ensure to apply inheritance and search the parent objects, when a value is not found at the current level.

For example:

However the Metadata can also be accessed directly, the internal variable names are stored in the RunOutputAttr::sVar* strings

Constructor & Destructor Documentation

◆ ~RunOutputAttr()

virtual ansys::Project::RunOutputAttr::~RunOutputAttr ( )

inlinevirtual

Member Function Documentation

◆ getCaseId()

int ansys::Project::RunOutputAttr::getCaseId ( ) const

Returns the specified variable (if available)

◆ getConnectivityId()

int ansys::Project::RunOutputAttr::getConnectivityId ( ) const

Returns the specified variable (if available)

If not available, will return the mesh-id instead

◆ getCoordinatesId()

int ansys::Project::RunOutputAttr::getCoordinatesId ( ) const

Returns the specified variable (if available)

If not available, will return the mesh-id instead

◆ getCrankAngle()

double ansys::Project::RunOutputAttr::getCrankAngle ( ) const

Returns the specified variable (if available)

◆ getDomainTransformationId()

int ansys::Project::RunOutputAttr::getDomainTransformationId ( ) const

Returns the specified variable (if available)

If not available, will return the input-settings-id instead

◆ getFirstIteratorForCurrent()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrent ( const std::string & pVar ) const

Return the first entry in the current Run, with same variable value.

Can be used either on a Result or an Output iterator.

A Run contains a sequence of Output, for the current Output, will search the first entry in the parent run sequence which has the same variable value.

For example: mesh-id 0,0,1,1,0 the last entry [4] is using the same mesh as the two first steps [0] and [1] the iterator returned would be [0]

If this function is called on a Result iterator, it will return the matching result in the found Output, with the same data type.

◆ getFirstIteratorForCurrentCaseId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentCaseId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentConnectivityId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentConnectivityId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentCoordinatesId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentCoordinatesId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentDomainTransformationId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentDomainTransformationId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentInputSettingsId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentInputSettingsId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentLocationId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentLocationId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentMeshId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentMeshId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentPhysicsId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentPhysicsId ( ) const

See getFirstIterator(const std::string&)

◆ getFirstIteratorForCurrentTopologyId()

Iterator ansys::Project::RunOutputAttr::getFirstIteratorForCurrentTopologyId ( ) const

See getFirstIterator(const std::string&)

◆ getIndex()

int ansys::Project::RunOutputAttr::getIndex ( ) const

Returns the output index (incremental id in a run) - always available.

◆ getInputSettingsId()

int ansys::Project::RunOutputAttr::getInputSettingsId ( ) const

Returns the specified variable (if available)

If not available, will return the case-id instead

◆ getIterator()

virtual Iterator ansys::Project::RunOutputAttr::getIterator ( ) const

protectedpure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, ansys::Project::Run, and ansys::Project::RunGroup.

◆ getLocationId()

int ansys::Project::RunOutputAttr::getLocationId ( ) const

Returns the specified variable (if available)

If not available, will return 0

◆ getMeshId()

int ansys::Project::RunOutputAttr::getMeshId ( ) const

Returns the specified variable (if available)

◆ getOutputSettingsId()

int ansys::Project::RunOutputAttr::getOutputSettingsId ( ) const

Returns the specified variable (if available)

◆ getPhysicsId()

int ansys::Project::RunOutputAttr::getPhysicsId ( ) const

Returns the specified variable (if available)

If not available, will return the input-settings-id instead

◆ getSolverIteration()

int ansys::Project::RunOutputAttr::getSolverIteration ( ) const

Returns the number of solver iterations (if available)

◆ getTime()

double ansys::Project::RunOutputAttr::getTime ( ) const

Returns the transient time value (if available)

◆ getTopologyId()

int ansys::Project::RunOutputAttr::getTopologyId ( ) const

Returns the specified variable (if available)

If not available, will return the mesh-id instead

◆ getValue()

virtual std::string ansys::Project::RunOutputAttr::getValue	(	const std::string &	pVar,
		bool	pFlagInherited
	)		const

pure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, and ansys::Project::Run.

◆ getValueDouble()

virtual double ansys::Project::RunOutputAttr::getValueDouble	(	const std::string &	pVar,
		bool	pFlagInherited
	)		const

pure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, and ansys::Project::Run.

◆ getValueInt()

virtual int ansys::Project::RunOutputAttr::getValueInt	(	const std::string &	pVar,
		bool	pFlagInherited
	)		const

pure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, and ansys::Project::Run.

◆ getValues()

std::vector< std::string > ansys::Project::RunOutputAttr::getValues	(	const std::vector< std::string > &	pVars,
		bool	pFlagInherited
	)		const

Returns the values for a list of variables.

◆ getValueType()

virtual MetaVariableType ansys::Project::RunOutputAttr::getValueType	(	const std::string &	pVar,
		bool	pFlagInherited
	)		const

pure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, and ansys::Project::Run.

◆ hasValue()

virtual bool ansys::Project::RunOutputAttr::hasValue	(	const std::string &	pVar,
		bool	pFlagInherited
	)		const

pure virtual

Implemented in ansys::Project::Output, ansys::Project::Result, and ansys::Project::Run.