Class representing a result variable description. More...

#include <FFaResultDescription.H>

Inheritance diagram for FFaResultDescription:

Public Member Functions
	FFaResultDescription (const char *name=NULL, int bid=0, int uid=0)
	Default constructor. More...

virtual	~FFaResultDescription ()
	Empty destructor. More...

void	clear ()
	Clears the result description, resetting it to default values. More...

void	copyResult (const FFaResultDescription &other)
	Copies the result path (but leaves the type and ID untouched). More...

std::string	getText () const
	Returns a textural description of the result path. More...

bool	isTime () const
	Returns true if this describes a time-dependent result quantity. More...

bool	isBeamSectionResult () const
	Returns true if this describes a beam section result quantity. More...

bool	empty () const
	Returns true if this result description is empty (no results). More...

bool	operator== (const FFaResultDescription &entry) const
	Equality operator. More...

Public Attributes
std::string	OGType
	Top-level variable type (owner group) More...

int	baseId
	Unique ID over the entire model. More...

int	userId
	Unique only within owner group. More...

std::string	varRefType
	Variable type description. More...

std::vector< std::string >	varDescrPath
	Below top-level variable. More...

Detailed Description

Class representing a result variable description.

This class is used to represent result quantities in a Fedem model. it contains q unique identification of the mechanism object the result quantity is associated with, the type of result, and a path in the result field hierarchy pointing to the unique result variable.

See also: FFrResultContainer.; FFrExtractor.

Constructor & Destructor Documentation

◆ FFaResultDescription()

FFaResultDescription::FFaResultDescription	(	const char *	name = `NULL`,
		int	bid = `0`,
		int	uid = `0`
	)

inline

Default constructor.

◆ ~FFaResultDescription()

virtual FFaResultDescription::~FFaResultDescription ( )

inlinevirtual

Empty destructor.

Member Function Documentation

◆ clear()

void FFaResultDescription::clear ( )

Clears the result description, resetting it to default values.

◆ copyResult()

void FFaResultDescription::copyResult ( const FFaResultDescription & other )

Copies the result path (but leaves the type and ID untouched).

◆ empty()

bool FFaResultDescription::empty ( ) const

inline

Returns true if this result description is empty (no results).

◆ getText()

std::string FFaResultDescription::getText ( ) const

Returns a textural description of the result path.

◆ isBeamSectionResult()

bool FFaResultDescription::isBeamSectionResult ( ) const

Returns true if this describes a beam section result quantity.

◆ isTime()

bool FFaResultDescription::isTime ( ) const

Returns true if this describes a time-dependent result quantity.

◆ operator==()

bool FFaResultDescription::operator== ( const FFaResultDescription & entry ) const

Equality operator.

Member Data Documentation

◆ baseId

int FFaResultDescription::baseId

Unique ID over the entire model.

◆ OGType

std::string FFaResultDescription::OGType

Top-level variable type (owner group)

◆ userId

int FFaResultDescription::userId

Unique only within owner group.

◆ varDescrPath

std::vector<std::string> FFaResultDescription::varDescrPath

Below top-level variable.

◆ varRefType

std::string FFaResultDescription::varRefType

Variable type description.

The documentation for this class was generated from the following files:

fedem-foundation/src/FFaLib/FFaDefinitions/FFaResultDescription.H
fedem-foundation/src/FFaLib/FFaDefinitions/FFaResultDescription.C

Public Member Functions

Public Attributes