Collective Variables Module - Developer Documentation
Public Member Functions | Public Attributes | List of all members
colvardeps::feature_state Struct Reference

This contains the current state of each feature for each object. More...

#include <colvardeps.h>

Public Member Functions

 feature_state (bool a, bool e)
 

Public Attributes

bool available
 Feature may be enabled, subject to possible dependencies.
 
bool enabled
 
int ref_count
 
std::vector< int > alternate_refs
 

Detailed Description

This contains the current state of each feature for each object.

Member Data Documentation

◆ alternate_refs

std::vector<int> colvardeps::feature_state::alternate_refs

List of features that were enabled by this one as part of an alternate requirement (for ref counting purposes) This is necessary because we don't know which feature in the list we enabled, otherwise

◆ enabled

bool colvardeps::feature_state::enabled

Currently enabled - this flag is subject to change dynamically TODO consider implications for dependency solving: anyone who disables it should trigger a refresh of parent objects

◆ ref_count

int colvardeps::feature_state::ref_count

Number of features requiring this one as a dependency When it falls to zero:

  • a dynamic feature is disabled automatically
  • other features may be disabled statically

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