TTTT Analysis  0.1
Public Member Functions | Protected Member Functions | List of all members
fv::Zip< ArgTypes > Class Template Reference

Zips a series of observations together. More...

#include <value.hpp>

Inheritance diagram for fv::Zip< ArgTypes >:
Inheritance graph
[legend]
Collaboration diagram for fv::Zip< ArgTypes >:
Collaboration graph
[legend]

Public Member Functions

 Zip (Value< std::vector< ArgTypes >> *... args, const std::string &alias)
 
- Public Member Functions inherited from fv::DerivedValue< std::vector< std::tuple< ArgTypes... > > >
 DerivedValue (const std::string &name, const std::string &alias="")
 
std::vector< std::tuple< ArgTypes... > > & get_value ()
 Calculate, if necessary, and return the value held by this object.
 
- Public Member Functions inherited from fv::Value< std::vector< std::tuple< ArgTypes... > > >
 Value (const std::string &name, const std::string &alias="")
 
- Public Member Functions inherited from fv::GenValue
 GenValue (const std::string &name, const std::string &alias)
 
const std::string & get_name ()
 
void set_name (const std::string &new_name)
 

Protected Member Functions

void update_value ()
 Updates the internal value. More...
 
std::string _get_name ()
 

Additional Inherited Members

- Static Public Member Functions inherited from fv::GenValue
static void reset ()
 
static GenValueget_value (const std::string &name)
 
static void alias (const std::string &name, GenValue *value)
 
static GenValuealias (const std::string &name)
 
static std::string summary ()
 
- Protected Attributes inherited from fv::DerivedValue< std::vector< std::tuple< ArgTypes... > > >
std::vector< std::tuple< ArgTypes... > > value
 
bool value_valid
 
- Static Protected Attributes inherited from fv::GenValue
static std::map< const std::string, GenValue * > values
 A static mapping containing all created Value objects. More...
 
static std::map< const std::string, GenValue * > aliases
 Composite value names are typically nested. More...
 

Detailed Description

template<typename... ArgTypes>
class fv::Zip< ArgTypes >

Zips a series of observations together.

Member Function Documentation

§ update_value()

template<typename... ArgTypes>
void fv::Zip< ArgTypes >::update_value ( )
inlineprotectedvirtual

Updates the internal value.

This function should be overridden by any child class to do the actual work of updating value based on whatever rules the class chooses. Normally, this consists of geting the values from some associated Value objects, doing some calculation on them, and storing the result in value.

Implements fv::DerivedValue< std::vector< std::tuple< ArgTypes... > > >.


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