---

csimClassInfo Class Reference

#include <csimclass.h>

List of all members.

---

Detailed Description

Holds information about a class like name, description and field informations.

See also Setting and getting field values

[NOHEADER]

• int add (csimFieldInfo *fi)

  Add a field.
  
  

• int nRegFields

  Number of fields registerd.
  
  

• int lRegFields

  Number of slots currently allocated.
  
  

• csimFieldInfo ** regFields

  The array.
  
  

Public Member Functions

• int getFieldId (char *name)

  Return the Id of the field name.
  
  

• int nFields (void)

  Return the number of fields of the corresponding class.
  
  

• const char * getFieldName (int id)

  Return field name given the fiels ID.
  
  

• bool isFieldRW (int id)

  Return 1 if field is READWRITE.
  
  

• void listFields (void)

  Print al list of fields to stdout.
  
  

• int getFieldArraySize (void)

  Return the number of doubles needed to store all READWRITE fields.
  
  

Methods for registering various variable types as fields

• int registerField (char *base, const char *name, pDoubleField field, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for double
  
  

• int registerField (char *base, const char *name, pDoubleArray array, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for double *
  
  

• int registerField (char *base, const char *name, pFloatField field, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for float
  
  

• int registerField (char *base, const char *name, pFloatArray array, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for float *
  
  

• int registerField (char *base, const char *name, pIntField field, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for int
  
  

• int registerField (char *base, const char *name, pIntArray array, int access, int sz, double lb, double ub, const char *units, const char *desc)

  for int *
  
  

Public Attributes

• const char * name

  Name of the class for which information is stored.
  
  

• const char * description

  Short description of the class.
  
  

• int classId

  Id of the class (set by csimClassInfoDB).
  
  

Private Attributes

• int arraySize

  Number of doubles needed to store all READWRITE fields.
  
  

---

Member Function Documentation

int csimClassInfo::add (  csimFieldInfo *    fi )  [private]

Add a field. Dirty implementation of a list of csimFieldInfo objects

---