cee::ug::SimulationInfo Class Reference

Simple class containing metadata info for the simulation that produced the model database. More...

Public Member Functions

 SimulationInfo ()
 Constructs an empty object. More...
 
 SimulationInfo (const SimulationInfo &other)
 Construct a SimulationInfo as a copy of other. More...
 
SimulationInfooperator= (const SimulationInfo &rhs)
 Assigns other to this and returns a reference to this simulation info. More...
 
Str title () const
 Returns the simulation title. More...
 
void setTitle (const Str &title)
 Sets the simulation title. More...
 
Str description () const
 Returns the simulation description. More...
 
void setDescription (const Str &description)
 Sets the simulation description. More...
 
Str filename () const
 Returns the simulation filename. More...
 
void setFilename (const Str &filename)
 Sets the simulation filename. More...
 
Str sourceFilename () const
 Returns the simulation source filename. More...
 
void setSourceFilename (const Str &filename)
 Sets the simulation source filename. More...
 
SimulationType type () const
 Returns the simulation type. More...
 
void setType (SimulationType type)
 Sets the simulation info type. More...
 
SolutionType solutionType () const
 Returns the solution type. More...
 
void setSolutionType (SolutionType type)
 Sets the solution type. More...
 

Detailed Description

Simple class containing metadata info for the simulation that produced the model database.

A simulation info contains:

  • A title
  • A description
  • A filename
  • A source filename
  • A simulation type (structural, fluid, thermal,...)
  • A solution type (static, steady state, transient, ...)

Metadata for a simulation is accessed from the data source directory.

See also
DataSourceDirectory

Constructor & Destructor Documentation

cee::ug::SimulationInfo::SimulationInfo ( )

Constructs an empty object.

cee::ug::SimulationInfo::SimulationInfo ( const SimulationInfo other)

Construct a SimulationInfo as a copy of other.

Member Function Documentation

Str cee::ug::SimulationInfo::description ( ) const

Returns the simulation description.

Str cee::ug::SimulationInfo::filename ( ) const

Returns the simulation filename.

SimulationInfo & cee::ug::SimulationInfo::operator= ( const SimulationInfo rhs)

Assigns other to this and returns a reference to this simulation info.

void cee::ug::SimulationInfo::setDescription ( const Str description)

Sets the simulation description.

void cee::ug::SimulationInfo::setFilename ( const Str filename)

Sets the simulation filename.

void cee::ug::SimulationInfo::setSolutionType ( SolutionType  type)

Sets the solution type.

void cee::ug::SimulationInfo::setSourceFilename ( const Str filename)

Sets the simulation source filename.

void cee::ug::SimulationInfo::setTitle ( const Str title)

Sets the simulation title.

void cee::ug::SimulationInfo::setType ( SimulationType  type)

Sets the simulation info type.

SolutionType cee::ug::SimulationInfo::solutionType ( ) const

Returns the solution type.

cee::Str cee::ug::SimulationInfo::sourceFilename ( ) const

Returns the simulation source filename.

Str cee::ug::SimulationInfo::title ( ) const

Returns the simulation title.

SimulationType cee::ug::SimulationInfo::type ( ) const

Returns the simulation type.