SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Namespaces | Classes | Typedefs | Functions
smtk::io Namespace Reference

I/O utilities for the toolkit. More...

Namespaces

 mesh
 Mesh IO.
 

Classes

struct  AttRefInfo
 
class  AttributeReader
 
class  AttributeReaderInternals
 
class  AttributeWriter
 
class  ExportMesh
 Export an entire SMTK mesh resource from a file, or just sub-sections. More...
 
class  Helpers
 A collection of methods to aid I/O. More...
 
class  ImportMesh
 Import an entire SMTK mesh resource from a file, or just sub-sections. More...
 
class  ItemDefinitionsHelper
 A Helper class for parsing XML Nodes that represent Item Definition Sections currently used for Attribute Definitions as well as Value, Group, and Reference Item Definitions. More...
 
struct  ItemExpressionInfo
 
class  Logger
 Log messages for later presentation to a user or a file. More...
 
class  ModelToMesh
 
class  ReadMesh
 Read an entire SMTK mesh resource from a file, or just sub-sections. More...
 
class  WriteMesh
 Write an entire SMTK mesh resource from a file, or just sub-sections. More...
 
class  XmlDocV1Parser
 
class  XmlDocV2Parser
 
class  XmlDocV3Parser
 
class  XmlDocV4Parser
 
class  XmlDocV5Parser
 
class  XmlDocV6Parser
 
class  XmlStringWriter
 
class  XmlV2StringWriter
 
class  XmlV3StringWriter
 
class  XmlV4StringWriter
 
class  XmlV5StringWriter
 
class  XmlV6StringWriter
 

Typedefs

typedef smtk::shared_ptr< smtk::io::LoggerLoggerPtr
 

Functions

bool importFromCSV (smtk::attribute::GroupItem &item, const std::string &filename, Logger &logger, bool appendToGroup=false, const std::string &sep=",", const std::string &comment="")
 Populates a GroupItem from a CSV file. More...
 
bool importFromDoubleFile (smtk::attribute::GroupItem &item, const std::string &filename, Logger &logger, bool appendToGroup=false, const std::string &optionalSep=",", const std::string &comment="")
 Populates a GroupItem from a file of Doubles. More...
 
bool exportMesh (const std::string &filePath, smtk::mesh::ResourcePtr meshResource)
 
bool exportMesh (const std::string &filePath, smtk::mesh::ResourcePtr meshResource, smtk::model::ResourcePtr resource, const std::string &modelPropertyName)
 
smtk::mesh::ResourcePtr importMesh (const std::string &filePath, const smtk::mesh::InterfacePtr &interface)
 
smtk::mesh::ResourcePtr importMesh (const std::string &filePath, const smtk::mesh::InterfacePtr &interface, const std::string &domainPropertyName)
 
bool importMesh (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool importMesh (const std::string &filePath, smtk::mesh::ResourcePtr resource, const std::string &domainPropertyName)
 
smtk::io::mesh::Format meshFileFormat (const std::string &filePath)
 
template<typename J >
void to_json (J &json, const Logger::Record &rec)
 
smtk::mesh::ResourcePtr readMesh (const std::string &filePath, const smtk::mesh::InterfacePtr &interface, mesh::Subset subset)
 
smtk::mesh::ResourcePtr readEntireResource (const std::string &filePath, const smtk::mesh::InterfacePtr &interface)
 
smtk::mesh::ResourcePtr readDomain (const std::string &filePath, const smtk::mesh::InterfacePtr &interface)
 
smtk::mesh::ResourcePtr readDirichlet (const std::string &filePath, const smtk::mesh::InterfacePtr &interface)
 
smtk::mesh::ResourcePtr readNeumann (const std::string &filePath, const smtk::mesh::InterfacePtr &interface)
 
bool readMesh (const std::string &filePath, smtk::mesh::ResourcePtr resource, mesh::Subset subset)
 
bool readEntireResource (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool readDomain (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool readDirichlet (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool readNeumann (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool writeMesh (const std::string &filePath, smtk::mesh::ResourcePtr resource, mesh::Subset subset)
 
bool writeEntireResource (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool writeDomain (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool writeDirichlet (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool writeNeumann (const std::string &filePath, smtk::mesh::ResourcePtr resource)
 
bool writeMesh (smtk::mesh::ResourcePtr resource, mesh::Subset subset)
 
bool writeEntireResource (smtk::mesh::ResourcePtr resource)
 
bool writeDomain (smtk::mesh::ResourcePtr resource)
 
bool writeDirichlet (smtk::mesh::ResourcePtr resource)
 
bool writeNeumann (smtk::mesh::ResourcePtr resource)
 

Detailed Description

I/O utilities for the toolkit.

Typedef Documentation

◆ LoggerPtr

typedef smtk::shared_ptr<smtk::io::Logger> smtk::io::LoggerPtr

Function Documentation

◆ importFromCSV()

SMTKCORE_EXPORT bool smtk::io::importFromCSV ( smtk::attribute::GroupItem item,
const std::string &  filename,
Logger logger,
bool  appendToGroup = false,
const std::string &  sep = ",",
const std::string &  comment = "" 
)

Populates a GroupItem from a CSV file.

This function can be used on an extensible GroupItem that only contains non-option, non-extensible ValueItems. Any active children associated with these items are ignored.

The function will either overwrite or append groups to the item depending on the appendToGroup parameter. Any line that starts with the comment character will be skipped but no logged. Any line in the CSV file that does not contain the proper number of values (based on the item's definition's children) will be logged and skipped. Empty values will result in in the corresponding value being unset. Any value in the CSV file that can not be converted into the appropriate data type or is invalid based on the corresponding item's definition will be ignored and logged. See groupItemCVSTest.cxx for an example of using the function.

◆ importFromDoubleFile()

SMTKCORE_EXPORT bool smtk::io::importFromDoubleFile ( smtk::attribute::GroupItem item,
const std::string &  filename,
Logger logger,
bool  appendToGroup = false,
const std::string &  optionalSep = ",",
const std::string &  comment = "" 
)

Populates a GroupItem from a file of Doubles.

This function can be used on an extensible GroupItem that only contains non-option, non-extensible DoubleItems. Any active children associated with these items are ignored. The file is assume to contain doubles that are separated by either whitespace and/or by an optional separator character. If an invalid character is found, the line will be skipped and logged. Any line that starts with the comment character will be skipped but no logged. Any line in the file that contain less than the proper number of values (based on the item's definition's children) will be logged and skipped.

The function will either overwrite or append groups to the item depending on the appendToGroup parameter. See groupItemDoubleFileTest.cxx for an example of using the function.