ACCELERATOR PHYSICS GROUP

Namespace Attributes

(Return to index)

A collection of routines to construct and read object attributes.

This namespace is part of the interface to the class Attribute, used to store object attributes.

Include file: ./Attributes/Attributes.hh

Synopsis:

  • class Bool ;
  • class BoolArray ;
  • class Place ;
  • class Range ;
  • class Real ;
  • class RealArray ;
  • class Reference ;
  • class String ;
  • class StringArray ;
  • class TableRow ;
  • class TokenList ;
  • class TokenListArray ;
  • bool getBool (const Attribute&) ;
  • extern std::vector<bool> getBoolArray (const Attribute&) ;
  • extern PlaceRep getPlace (const Attribute&) ;
  • extern RangeRep getRange (const Attribute&) ;
  • extern double getReal (const Attribute&) ;
  • extern std::vector<double> getRealArray (const Attribute&) ;
  • extern string getString (const Attribute&) ;
  • extern std::vector<string> getStringArray (const Attribute&) ;
  • extern TableRowRep getTableRow (const Attribute&) ;
  • extern std::list<Token> getTokenList (const Attribute&) ;
  • extern std::vector<std::list<Token> > getTokenListArray (const Attribute&) ;
  • extern Attribute makeBool (const string&,const string&) ;
  • extern Attribute makeBool (const string&,const string&,bool) ;
  • extern Attribute makeBoolArray (const string&,const string&) ;
  • extern Attribute makePlace (const string&,const string&) ;
  • extern Attribute makeRange (const string&,const string&) ;
  • extern Attribute makeReal (const string&,const string&) ;
  • extern Attribute makeReal (const string&,const string&,double) ;
  • extern Attribute makeRealArray (const string&,const string&) ;
  • extern Attribute makeReference (const string&,const string&) ;
  • extern Attribute makeString (const string&,const string&) ;
  • extern Attribute makeString (const string&,const string&,const string&) ;
  • extern Attribute makeStringArray (const string&,const string&) ;
  • extern Attribute makeTableRow (const string&,const string&) ;
  • extern Attribute makeTokenList (const string&,const string&) ;
  • extern Attribute makeTokenListArray (const string&,const string&) ;
  • extern void setBool (Attribute&,bool) ;
  • extern void setBoolArray (Attribute&,const std::vector<bool>&) ;
  • extern void setPlace (Attribute&,const PlaceRep&) ;
  • extern void setRange (Attribute&,const RangeRep&) ;
  • extern void setReal (Attribute&,double) ;
  • extern void setRealArray (Attribute&,const std::vector<double>&) ;
  • extern void setString (Attribute&,const string&) ;
  • extern void setStringArray (Attribute&,const std::vector<string>&) ;
  • extern void setTableRow (Attribute&,const TableRowRep&) ;
  • extern void setTokenList (Attribute&,const std::list<Token>&) ;
  • extern void setTokenListArray (Attribute&,const std::vector<std::list<Token> >&) ;

    Detailed descriptions:

    class Bool ;
    Parser for attribute of type logical.

    class BoolArray ;
    Parser for an attribute of type logical array.

    class Place ;
    Parser for an attribute of type place reference.

    class Range ;
    Parser for an attribute of type range definition.

    class Real ;
    Parser for an attribute of type real.

    class RealArray ;
    Parser for an attribute of type real array.

    class Reference ;
    Parser for an attribute of type attribute reference.
    The attribute referred to may be logical, real, or string.

    class String ;
    Parser for an attribute of type string.

    class StringArray ;
    Parser for an attribute of type string array.

    class TableRow ;
    Parser for an attribute of type table row reference.

    class TokenList ;
    Parser for an attribute of type token list.
    Such an attribute can encode e.g. an expression.

    class TokenListArray ;
    Parser for an attribute of type token list array.
    Such an attribute may encode a list of expressions.

    bool getBool (const Attribute&) ;
    Return logical value.
    Evaluate any expression and return value. If the expression is non-deferred, the value is cached. Re-evaluation takes place only if a new definition has been read.

    extern std::vector<bool> getBoolArray (const Attribute&) ;
    Get logical array value.

    extern PlaceRep getPlace (const Attribute&) ;
    Get place value.

    extern RangeRep getRange (const Attribute&) ;
    Get range value.

    extern double getReal (const Attribute&) ;
    Return real value.

    extern std::vector<double> getRealArray (const Attribute&) ;
    Get array value.

    extern string getString (const Attribute&) ;
    Get string value.

    extern std::vector<string> getStringArray (const Attribute&) ;
    Get string array value.

    extern TableRowRep getTableRow (const Attribute&) ;
    Get table row value.

    extern std::list<Token> getTokenList (const Attribute&) ;
    Return token list value.

    extern std::vector<std::list<Token> > getTokenListArray (const Attribute&) ;
    Return token list array value.

    extern Attribute makeBool (const string&,const string&) ;
    Make logical attribute.
    Initial value undefined.

    extern Attribute makeBool (const string&,const string&,bool) ;
    Make logical attribute.
    Initial value defined.

    extern Attribute makeBoolArray (const string&,const string&) ;
    Create a logical array attribute.
    Initial value is empty array.

    extern Attribute makePlace (const string&,const string&) ;
    Create a place attribute.
    Initial value is "#S".

    extern Attribute makeRange (const string&,const string&) ;
    Create a range attribute.
    Initial value is "FULL".

    extern Attribute makeReal (const string&,const string&) ;
    Make real attribute.
    Initial value is undefined.

    extern Attribute makeReal (const string&,const string&,double) ;
    Make real attribute.
    Initial value is defined.

    extern Attribute makeRealArray (const string&,const string&) ;
    Create real array attribute.
    Initial value is empty array.

    extern Attribute makeReference (const string&,const string&) ;
    Create a reference attribute.
    Initial value is undefined.

    extern Attribute makeString (const string&,const string&) ;
    Make string attribute.
    Initial value undefined.

    extern Attribute makeString (const string&,const string&,const string&) ;
    Make string attribute.
    Initial value is defined.

    extern Attribute makeStringArray (const string&,const string&) ;
    Create a string array attribute.
    Initial value is empty array.

    extern Attribute makeTableRow (const string&,const string&) ;
    Create a table row attribute.
    Initial value is undefined.

    extern Attribute makeTokenList (const string&,const string&) ;
    Make token list attribute.
    Initial value is empty list.

    extern Attribute makeTokenListArray (const string&,const string&) ;
    Make token list attribute.
    Initial value is empty array.

    extern void setBool (Attribute&,bool) ;
    Set logical value.

    extern void setBoolArray (Attribute&,const std::vector<bool>&) ;
    Set logical array value.

    extern void setPlace (Attribute&,const PlaceRep&) ;
    Set place value.

    extern void setRange (Attribute&,const RangeRep&) ;
    Set range value.

    extern void setReal (Attribute&,double) ;
    Set real value.

    extern void setRealArray (Attribute&,const std::vector<double>&) ;
    Set array value.

    extern void setString (Attribute&,const string&) ;
    Set string value.

    extern void setStringArray (Attribute&,const std::vector<string>&) ;
    Set string array value.

    extern void setTableRow (Attribute&,const TableRowRep&) ;
    Set table row value.

    extern void setTokenList (Attribute&,const std::list<Token>&) ;
    Set token list value.

    extern void setTokenListArray (Attribute&,const std::vector<std::list<Token> >&) ;
    Set token list array value.


    Documentation generated by fci on Mon Feb 7 12:30:14 2000