HepMC event record
Public Member Functions | Protected Member Functions
StringAttribute Class Reference

Detailed Description

Attribute that holds a string.

Default attribute constructed when reading input files. It can be then parsed by other attributes or left as a string.

Definition at line 326 of file build/outputs/include/HepMC/Attribute.h.

#include <Attribute.h>

+ Inheritance diagram for StringAttribute:
+ Collaboration diagram for StringAttribute:

Public Member Functions

 StringAttribute ()
 Default constructor - empty string. More...
 
 StringAttribute (const string &st)
 String-based constructor. More...
 
bool from_string (const string &att)
 Implementation of Attribute::from_string. More...
 
bool to_string (string &att) const
 Implementation of Attribute::to_string. More...
 
string value () const
 get the value associated to this Attribute. More...
 
void set_value (string s)
 set the value associated to this Attribute. More...
 
 StringAttribute ()
 Default constructor - empty string. More...
 
 StringAttribute (const string &st)
 String-based constructor. More...
 
bool from_string (const string &att)
 Implementation of Attribute::from_string. More...
 
bool to_string (string &att) const
 Implementation of Attribute::to_string. More...
 
string value () const
 get the value associated to this Attribute. More...
 
void set_value (string s)
 set the value associated to this Attribute. More...
 
virtual bool init (const GenEvent &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenEvent &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string. More...
 
bool is_parsed ()
 Check if this attribute is parsed. More...
 
bool is_parsed ()
 Check if this attribute is parsed. More...
 
const string & unparsed_string () const
 Get unparsed string. More...
 
const string & unparsed_string () const
 Get unparsed string. More...
 

Protected Member Functions

void set_is_parsed (bool flag)
 Set is_parsed flag. More...
 
void set_is_parsed (bool flag)
 Set is_parsed flag. More...
 
void set_unparsed_string (const string &st)
 Set unparsed string. More...
 
void set_unparsed_string (const string &st)
 Set unparsed string. More...
 

Constructor & Destructor Documentation

◆ StringAttribute() [1/4]

StringAttribute ( )
inline

Default constructor - empty string.

Definition at line 330 of file build/outputs/include/HepMC/Attribute.h.

◆ StringAttribute() [2/4]

StringAttribute ( const string &  st)
inline

String-based constructor.

The Attribute constructor used here marks that this is an unparsed string that can be (but does not have to be) parsed

Definition at line 338 of file build/outputs/include/HepMC/Attribute.h.

◆ StringAttribute() [3/4]

StringAttribute ( )
inline

Default constructor - empty string.

Definition at line 330 of file include/HepMC/Attribute.h.

◆ StringAttribute() [4/4]

StringAttribute ( const string &  st)
inline

String-based constructor.

The Attribute constructor used here marks that this is an unparsed string that can be (but does not have to be) parsed

Definition at line 338 of file include/HepMC/Attribute.h.

Member Function Documentation

◆ from_string() [1/2]

bool from_string ( const string &  att)
inlinevirtual

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 341 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::set_unparsed_string().

◆ from_string() [2/2]

bool from_string ( const string &  att)
inlinevirtual

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 341 of file include/HepMC/Attribute.h.

References Attribute::set_unparsed_string().

◆ init() [1/4]

virtual bool init ( const GenEvent )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file build/outputs/include/HepMC/Attribute.h.

◆ init() [2/4]

virtual bool init ( const GenEvent )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file include/HepMC/Attribute.h.

◆ init() [3/4]

virtual bool init ( const GenRunInfo )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file build/outputs/include/HepMC/Attribute.h.

◆ init() [4/4]

virtual bool init ( const GenRunInfo )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file include/HepMC/Attribute.h.

◆ is_parsed() [1/2]

bool is_parsed ( )
inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ is_parsed() [2/2]

bool is_parsed ( )
inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ set_is_parsed() [1/2]

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 101 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ set_is_parsed() [2/2]

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 101 of file include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ set_unparsed_string() [1/2]

void set_unparsed_string ( const string &  st)
inlineprotectedinherited

Set unparsed string.

Definition at line 104 of file include/HepMC/Attribute.h.

References Attribute::m_string.

◆ set_unparsed_string() [2/2]

void set_unparsed_string ( const string &  st)
inlineprotectedinherited

Set unparsed string.

Definition at line 104 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_string.

◆ set_value() [1/2]

void set_value ( string  s)
inline

set the value associated to this Attribute.

Definition at line 358 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::set_unparsed_string().

◆ set_value() [2/2]

void set_value ( string  s)
inline

set the value associated to this Attribute.

Definition at line 358 of file include/HepMC/Attribute.h.

References Attribute::set_unparsed_string().

◆ to_string() [1/2]

bool to_string ( string &  att) const
inlinevirtual

Implementation of Attribute::to_string.

Implements Attribute.

Definition at line 347 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::unparsed_string().

◆ to_string() [2/2]

bool to_string ( string &  att) const
inlinevirtual

Implementation of Attribute::to_string.

Implements Attribute.

Definition at line 347 of file include/HepMC/Attribute.h.

References Attribute::unparsed_string().

◆ unparsed_string() [1/2]

const string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 97 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_string.

◆ unparsed_string() [2/2]

const string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 97 of file include/HepMC/Attribute.h.

References Attribute::m_string.

◆ value() [1/2]

string value ( ) const
inline

get the value associated to this Attribute.

Definition at line 353 of file include/HepMC/Attribute.h.

References Attribute::unparsed_string().

◆ value() [2/2]

string value ( ) const
inline

get the value associated to this Attribute.

Definition at line 353 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::unparsed_string().


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