Class XMLStateReader
Defined in File XMLStateReader.h
Inheritance Relationships
Base Type
public flamegpu::io::StateReader
(Class StateReader)
Class Documentation
-
class XMLStateReader : public flamegpu::io::StateReader
XML format StateReader
Public Functions
Constructs a reader capable of reading model state from XML files Environment properties will be read into the Simulation instance pointed to by ‘sim_instance_id’ Agent data will be read into ‘model_state’
- Parameters:
model_name – Name from the model description hierarchy of the model to be loaded
env_desc – Environment description for validating property data on load
env_init – Dictionary of loaded values map:<{name, index}, value>
model_state – Map of AgentVector to load the agent data into per agent, key should be agent name
input_file – Filename of the input file (This will be used to determine which reader to return)
sim_instance – Instance of the Simulation object (This is used for setting/getting config)
-
virtual int parse() override
parses the xml file
Actual performs the XML parsing to load the model state
- Throws:
exception::TinyXMLError – If parsing of the input file fails
- Returns:
Always tinyxml2::XML_SUCCESS