OpenStructure
Public Types | Public Member Functions | Data Fields
Prop Struct Reference

#include <property_id.hh>

Public Types

enum  ID {
  RNAME , ANAME , CNAME , ELE ,
  RNUM , ANUM , AX , AY ,
  AZ , OCC , AINDEX , RTYPE ,
  ISHETATM , RBFAC , ABFAC , PEPTIDE ,
  NUCLEOTIDE , ACHARGE , RINDEX , PROTEIN ,
  LIGAND , WATER , WITHIN , UNDEF ,
  CUSTOM
}
 
enum  Level { ATOM =0 , RESIDUE =1 , CHAIN =2 , UNSPECIFIED =3 }
 
enum  Type { STRING , INT , FLOAT , VEC_DIST }
 

Public Member Functions

 Prop (ID i, Type t, Level l)
 
 Prop ()
 
bool operator== (const Prop &rhs) const
 
bool operator!= (const Prop &rhs) const
 
String GetName () const
 
String GetTypeName () const
 

Data Fields

ID id
 
Type type
 
Level level
 

Detailed Description

Definition at line 31 of file property_id.hh.

Member Enumeration Documentation

◆ ID

enum ID

Defined properties.

CUSTOM is for GenericFloatProperties. It must always be the last, because it is used as an index to determine in which order the generic properties where specified in the query string. GenericProperties are defined with gapropname, grpropname, gcpropname for the GenericProp 'propname' at the atom, residue and chain level respectively.

Enumerator
RNAME 
ANAME 
CNAME 
ELE 
RNUM 
ANUM 
AX 
AY 
AZ 
OCC 
AINDEX 
RTYPE 
ISHETATM 
RBFAC 
ABFAC 
PEPTIDE 
NUCLEOTIDE 
ACHARGE 
RINDEX 
PROTEIN 
LIGAND 
WATER 
WITHIN 
UNDEF 
CUSTOM 

Definition at line 41 of file property_id.hh.

◆ Level

enum Level
Enumerator
ATOM 
RESIDUE 
CHAIN 
UNSPECIFIED 

Definition at line 47 of file property_id.hh.

◆ Type

enum Type
Enumerator
STRING 
INT 
FLOAT 
VEC_DIST 

Definition at line 51 of file property_id.hh.

Constructor & Destructor Documentation

◆ Prop() [1/2]

Prop ( ID  i,
Type  t,
Level  l 
)
inline

Definition at line 59 of file property_id.hh.

◆ Prop() [2/2]

Prop ( )
inline

Definition at line 63 of file property_id.hh.

Member Function Documentation

◆ GetName()

String GetName ( ) const

◆ GetTypeName()

String GetTypeName ( ) const

◆ operator!=()

bool operator!= ( const Prop rhs) const
inline

Definition at line 72 of file property_id.hh.

◆ operator==()

bool operator== ( const Prop rhs) const
inline

Definition at line 67 of file property_id.hh.

Field Documentation

◆ id

ID id

Definition at line 55 of file property_id.hh.

◆ level

Level level

Definition at line 57 of file property_id.hh.

◆ type

Type type

Definition at line 56 of file property_id.hh.


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