Description

Base class for all YAML parsers.

#include <ChParserYAML.h>

Inheritance diagram for chrono::parsers::ChParserYAML:

[legend]

Collaboration diagram for chrono::parsers::ChParserYAML:

Public Types
enum	YamlFileType { MBS, SPH, TDPF, FSI, VEHICLE, UNKNOWN }
	Type of a Chrono YAML specification file.

Public Member Functions
void	SetVerbose (bool verbose)
	Set verbose terminal output (default: false).

virtual void	SetOutputDir (const std::string &out_dir)
	Set root output directory (default: "."). More...

const std::string &	GetName () const
	Return the name of the YAML model.

virtual bool	Output () const
	Return true if generating output.

ChOutput::Type	GetOutputType () const
	Return the output type.

ChOutput::Mode	GetOutputMode () const
	Return the output mode.

virtual double	GetOutputFPS () const
	Return the output frequency.

virtual void	SaveOutput (int frame)
	Save simulation output results at the current time. More...

Static Public Member Functions
static YamlFileType	ReadYamlFileType (const std::string &yaml_filename)
	Peek in specified YAML file and read the fluid system type. More...

Protected Member Functions
void	ReadOutputParams (const YAML::Node &a)
	Read output settings from specified YAML node.

Static Protected Member Functions
static YamlFileType	ReadYamlFileType (const YAML::Node &a)
	Read the YAML file type.

Protected Attributes
std::string	m_name
	name of the YAML model

bool	m_verbose
	verbose terminal output (default: false)

bool	m_use_degrees
	all angles given in degrees (default: true)

std::string	m_output_dir
	root output directory

std::shared_ptr< ChOutput >	m_output_db
	output database

OutputParameters	m_output
	output parameters

ChYamlFileHandler	m_file_handler
	handler for data file paths

Member Function Documentation

ChParserYAML::YamlFileType chrono::parsers::ChParserYAML::ReadYamlFileType ( const std::string & yaml_filename )

static

Peek in specified YAML file and read the fluid system type.

Throws a runtime error if the type is unknown.

void chrono::parsers::ChParserYAML::SaveOutput ( int frame )

virtual

Save simulation output results at the current time.

This base class implementation creates and initializes the output database. Derived classes must

void chrono::parsers::ChParserYAML::SetOutputDir ( const std::string & out_dir )

virtual

Set root output directory (default: ".").

The specified directory must exist.

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