OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
SDDS::parameter Struct Reference

#include <parameter.hpp>

Classes

struct  complainUnsupported
 

Public Types

enum class  attributes {
  NAME , SYMBOL , UNITS , DESCRIPTION ,
  FORMAT_STRING , TYPE , FIXED_VALUE
}
 

Public Member Functions

bool checkMandatories () const
 
bool parse (std::string_view input, std::size_t &pos)
 

Public Attributes

unsigned int order_m { 0 }
 
std::optional< std::string > name_m
 
std::optional< std::string > units_m
 
std::optional< std::string > description_m
 
std::optional< ast::dataType > type_m
 
ast::variant_t value_m
 

Static Public Attributes

static unsigned int count_m
 

Detailed Description

Definition at line 34 of file parameter.hpp.

Member Enumeration Documentation

◆ attributes

enum class SDDS::parameter::attributes
strong
Enumerator
NAME 
SYMBOL 
UNITS 
DESCRIPTION 
FORMAT_STRING 
TYPE 
FIXED_VALUE 

Definition at line 35 of file parameter.hpp.

Member Function Documentation

◆ checkMandatories()

bool SDDS::parameter::checkMandatories ( ) const
inline

Definition at line 53 of file parameter.hpp.

References name_m, and type_m.

Referenced by SDDS::parser::SimpleParser::parseParameter().

◆ parse()

bool SDDS::parameter::parse ( std::string_view  input,
std::size_t &  pos 
)
inline

Member Data Documentation

◆ count_m

unsigned int SDDS::parameter::count_m
static

Definition at line 51 of file parameter.hpp.

Referenced by SDDS::parameterOrder< Iterator >::operator()().

◆ description_m

std::optional<std::string> SDDS::parameter::description_m

Definition at line 48 of file parameter.hpp.

Referenced by SDDS::operator<<(), and SDDS::parser::SimpleParser::parseParameter().

◆ name_m

std::optional<std::string> SDDS::parameter::name_m

◆ order_m

unsigned int SDDS::parameter::order_m { 0 }

Definition at line 45 of file parameter.hpp.

Referenced by SDDS::parameterOrder< Iterator >::operator()(), and SDDS::operator<<().

◆ type_m

std::optional<ast::dataType> SDDS::parameter::type_m

◆ units_m

std::optional<std::string> SDDS::parameter::units_m

Definition at line 47 of file parameter.hpp.

Referenced by SDDS::operator<<(), and SDDS::parser::SimpleParser::parseParameter().

◆ value_m

ast::variant_t SDDS::parameter::value_m

Definition at line 50 of file parameter.hpp.


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