protocols::constel::ResidueMask Class Reference

#include <ResidueMask.hh>

Inheritance diagram for protocols::constel::ResidueMask:

Public Member Functions
	ResidueMask (core::pose::Pose &ps, std::string const &fname)
	: reads a residue mask from file More...
bool	operator[] (core::Size const i)
	: the mask's subscription operator More...
void	print (std::ostream &os) const
	: prints the residue mask as a binary string More...

Private Attributes
utility::vector1< bool >	mask

Constructor & Destructor Documentation

protocols::constel::ResidueMask::ResidueMask	(	core::pose::Pose &	ps,
		std::string const &	fname
	)

: reads a residue mask from file

Parameters

[in]	ps	pose over whose residues the mask is defined
[in]	fname	path to the input file

The input file lists the residues whose bit must be set to true. The format of the file is the following: I1 C1
... IN CN
, where Ii and Ci are the residue index and the chain ID, respectively, of the ith residue whose bit must be set to true (i=1,...,N).

References mask, core::pose::Pose::pdb_info(), and protocols::constel::TR().

Member Function Documentation

bool protocols::constel::ResidueMask::operator[]

(

core::Size const

i

)

: the mask's subscription operator

Parameters

[in]

i

index in mask

Returns

value of the mask at that index

References mask.

void protocols::constel::ResidueMask::print

(

std::ostream &

os

)

const

: prints the residue mask as a binary string

Parameters

[out]

os

output stream

: the ith output digit equals 1 if the ith element in the mask is true; it equals 0 if the ith element is false (i=1,...,SIZ).

References mask.

Member Data Documentation

utility::vector1<bool> protocols::constel::ResidueMask::mask

private

Referenced by operator[](), print(), and ResidueMask().

---

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

• src/protocols/constel/ResidueMask.hh
• src/protocols/constel/ResidueMask.cc