LOOS  v2.3.2
loos::OptionsFramework::BasicSplitBy Class Reference

Provides a mechanism for controlling how to split an AtomicGroup. More...

#include <OptionsFramework.hpp>

Inheritance diagram for loos::OptionsFramework::BasicSplitBy:
Collaboration diagram for loos::OptionsFramework::BasicSplitBy:

Public Types

enum  SplitType { NONE, MOLECULE, SEGID, RESIDUE }
 

Public Member Functions

 BasicSplitBy (const std::string &method)
 
 BasicSplitBy (const std::string &method, const std::string &lbl)
 
std::vector< AtomicGroupsplit (const AtomicGroup &grp)
 
- Public Member Functions inherited from loos::OptionsFramework::OptionsPackage
virtual void addHidden (po::options_description &opts)
 Appends hidden options (these generally match positional)
 
virtual void addPositional (po::positional_options_description &opts)
 Appends positional options.
 
virtual bool check (po::variables_map &map)
 Validates passed options, returning true if there is a problem or false if not. More...
 
virtual std::string help () const
 Returns a slice of the example command-line in the help output. More...
 

Public Attributes

std::string split_method
 
std::string label
 
SplitType split_type
 

Detailed Description

Provides a mechanism for controlling how to split an AtomicGroup.

Definition at line 385 of file OptionsFramework.hpp.


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