NEST main@caf0ae8
 
Loading...
Searching...
No Matches
nest::RecordingBackendASCII::DeviceData Struct Reference

Public Member Functions

 DeviceData ()=delete
 
 DeviceData (std::string, std::string)
 
void set_value_names (const std::vector< std::string > &, const std::vector< std::string > &)
 
void open_file ()
 
void write (const Event &, const std::vector< double > &, const std::vector< long > &)
 
void flush_file ()
 
void close_file ()
 
void get_status (Dictionary &) const
 
void set_status (const Dictionary &)
 

Private Member Functions

std::string compute_filename_ () const
 Compose and return the filename.
 

Private Attributes

long precision_
 Number of decimal places used when writing decimal values.
 
bool time_in_steps_
 Should time be recorded in steps (ms if false)
 
std::string modelname_
 File name up to but not including the ".".
 
std::string vp_node_id_string_
 The vp and node ID component of the filename.
 
std::string file_extension_
 File name extension without leading ".".
 
std::string label_
 The label of the device.
 
std::ofstream file_
 File stream to use for the device.
 
std::vector< std::string > double_value_names_
 names for values of type double
 
std::vector< std::string > long_value_names_
 names for values of type long
 

Constructor & Destructor Documentation

◆ DeviceData() [1/2]

nest::RecordingBackendASCII::DeviceData::DeviceData ( )
delete

◆ DeviceData() [2/2]

nest::RecordingBackendASCII::DeviceData::DeviceData ( std::string  modelname,
std::string  vp_node_id_string 
)

Member Function Documentation

◆ close_file()

void nest::RecordingBackendASCII::DeviceData::close_file ( )

◆ compute_filename_()

std::string nest::RecordingBackendASCII::DeviceData::compute_filename_ ( ) const
private

Compose and return the filename.

References nest::IOManager::get_data_path(), nest::IOManager::get_data_prefix(), nest::KernelManager::io_manager, and nest::kernel().

Here is the call graph for this function:

◆ flush_file()

void nest::RecordingBackendASCII::DeviceData::flush_file ( )

◆ get_status()

void nest::RecordingBackendASCII::DeviceData::get_status ( Dictionary &  d) const

References nest::names::file_extension(), nest::names::filenames(), nest::names::precision(), and nest::names::time_in_steps().

Referenced by nest::RecordingBackendASCII::get_device_defaults().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ open_file()

void nest::RecordingBackendASCII::DeviceData::open_file ( )

References nest::RecordingBackendASCII::ASCII_REC_BACKEND_VERSION, nest::ERROR, nest::kernel(), and LOG.

Here is the call graph for this function:

◆ set_status()

void nest::RecordingBackendASCII::DeviceData::set_status ( const Dictionary &  d)

References nest::names::file_extension(), nest::kernel(), nest::names::label(), nest::names::precision(), and nest::names::time_in_steps().

Referenced by nest::RecordingBackendASCII::check_device_status().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_value_names()

void nest::RecordingBackendASCII::DeviceData::set_value_names ( const std::vector< std::string > &  double_value_names,
const std::vector< std::string > &  long_value_names 
)

◆ write()

void nest::RecordingBackendASCII::DeviceData::write ( const Event &  event,
const std::vector< double > &  double_values,
const std::vector< long > &  long_values 
)

Member Data Documentation

◆ double_value_names_

std::vector< std::string > nest::RecordingBackendASCII::DeviceData::double_value_names_
private

names for values of type double

◆ file_

std::ofstream nest::RecordingBackendASCII::DeviceData::file_
private

File stream to use for the device.

◆ file_extension_

std::string nest::RecordingBackendASCII::DeviceData::file_extension_
private

File name extension without leading ".".

◆ label_

std::string nest::RecordingBackendASCII::DeviceData::label_
private

The label of the device.

◆ long_value_names_

std::vector< std::string > nest::RecordingBackendASCII::DeviceData::long_value_names_
private

names for values of type long

◆ modelname_

std::string nest::RecordingBackendASCII::DeviceData::modelname_
private

File name up to but not including the ".".

◆ precision_

long nest::RecordingBackendASCII::DeviceData::precision_
private

Number of decimal places used when writing decimal values.

◆ time_in_steps_

bool nest::RecordingBackendASCII::DeviceData::time_in_steps_
private

Should time be recorded in steps (ms if false)

◆ vp_node_id_string_

std::string nest::RecordingBackendASCII::DeviceData::vp_node_id_string_
private

The vp and node ID component of the filename.


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