CoordGroupHandle Class Reference

coordinate group, for trajectories and such More...

#include <coord_group.hh>


Public Member Functions

 CoordGroupHandle ()
EntityHandle GetEntity () const
uint GetAtomCount () const
uint GetFrameCount () const
void SetFramePositions (uint frame, const std::vector< geom::Vec3 > &clist)
void CopyFrame (uint frame)
void Capture ()
void CaptureInto (int pos)
void Capture (uint frame)
void AddFrame (const std::vector< geom::Vec3 > &clist)
void SetAtomPos (uint frame, AtomHandle atom, const geom::Vec3 &pos)
geom::Vec3 GetAtomPos (uint frame, AtomHandle atom) const
bool IsValid () const
 operator bool () const
AtomHandleList GetAtomList () const
CoordFramePtr GetFrame (uint frame) const

Friends

DLLEXPORT_OST_MOL CoordGroupHandle CreateCoordGroup (const std::vector< AtomHandle > &)


Detailed Description

coordinate group, for trajectories and such

Definition at line 35 of file coord_group.hh.


Constructor & Destructor Documentation

create empty, invalid handle


Member Function Documentation

void AddFrame ( const std::vector< geom::Vec3 > &  clist  ) 

add frame

void Capture ( uint  frame  ) 

store current atom positions in given frame (must exist)

void Capture (  ) 

store current atom positions in new frame

void CaptureInto ( int  pos  ) 

void CopyFrame ( uint  frame  ) 

copy atom positions of given frame to stored atoms in entity

uint GetAtomCount (  )  const

number of atoms per frame

AtomHandleList GetAtomList (  )  const

geom::Vec3 GetAtomPos ( uint  frame,
AtomHandle  atom 
) const

retrieve an indidivial atom position in the given frame

EntityHandle GetEntity (  )  const

return trajectories entity handle

CoordFramePtr GetFrame ( uint  frame  )  const

uint GetFrameCount (  )  const

number of frames

bool IsValid (  )  const

check for handle validity

operator bool (  )  const

whether the handle is valid

void SetAtomPos ( uint  frame,
AtomHandle  atom,
const geom::Vec3 pos 
)

set an indidivial atom position in the given frame

void SetFramePositions ( uint  frame,
const std::vector< geom::Vec3 > &  clist 
)

assign positions to the given frame - order and count must match initial atomlist


Friends And Related Function Documentation

DLLEXPORT_OST_MOL CoordGroupHandle CreateCoordGroup ( const std::vector< AtomHandle > &   )  [friend]


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

Generated on Fri Jul 2 14:23:07 2010 for OpenStructure by  doxygen 1.5.8