class ValueDefinition : public Object

(Return to index)

The base class for all MAD value definitions.

It implements the common behaviour of values, it can also be used via dynamic casting to determine whether an object represents a value.

Type:	Abstract
Superclasses:	public Object
Include file:	./AbstractObjects/ValueDefinition.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • virtual ~ValueDefinition () ;
  • virtual const string getCategory ()const ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • virtual bool getBool ()const ;
  • virtual bool getBoolComponent (int)const ;
  • virtual double getReal ()const ;
  • virtual double getRealComponent (int)const ;
  • virtual string getString ()const ;
  • virtual string getStringComponent (int)const ;
  • Attribute& value () ;
  • const Attribute& value ()const ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual Object* clone (const string&) = 0 ;
  • void copyAttributes (const Object&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual void execute () ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parse (Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void printHelp (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • virtual void update () ;
  • bool isBuiltin ()const ;
  • virtual bool isShared ()const ;
  • virtual void setShared (bool) ;
  • void setDirty (bool) ;
  • bool isDirty ()const ;
  • void setFlag (bool) ;
  • bool isFlagged ()const ;
  • void setDoomTime (double) ;
  • double getDoomTime ()const ;
  • const Object* getBaseObject ()const ;
  • const string& getMadName ()const ;
  • Object* getParent ()const ;
  • bool isTreeMember (const Object*)const ;
  • void setMadName (const string&) ;
  • void setParent (Object*) ;
  • void clear () ;
  • int increment () ;
  • int occurrenceCount () ;
  • void registerReference (AttributeBase*) ;
  • void unregisterReference (AttributeBase*) ;
  • std::vector<Attribute> itsAttr ;
• Protected Members:
  • ValueDefinition (int,const char*,const char*) ;
  • ValueDefinition (const string&,ValueDefinition*) ;
  • const string itsPrefix ;
  • bool builtin ;
  • bool modified ;
  • bool flagged ;

Documentation:

• Public members:

  virtual bool getBool ()const ;

  Return logical value.
  The default version throws MadException.

  virtual bool getBoolComponent (int)const ;

  Return indexed logical value.
  The default version throws MadException.

  virtual const string getCategory ()const ;

  Return the object category as a string.
  Return the string "VARIABLE".

  virtual double getReal ()const ;

  Return real value.
  The default version throws MadException.

  virtual double getRealComponent (int)const ;

  Return indexed real value.
  The default version throws MadException.

  virtual string getString ()const ;

  Return string value.
  The default version throws MadException.

  virtual string getStringComponent (int)const ;

  Return indexed string value.
  The default version throws MadException.

  virtual bool shouldTrace ()const ;

  Trace flag.
  If true, the object's execute() function should be traced. Always false for value definitions.

  virtual bool shouldUpdate ()const ;

  Update flag.
  If true, the data structure should be updated before calling execute(). Always false for value definitions.

  Attribute& value () ;

  Return the attribute representing the value of the definition.
  Version for non-constant object.

  const Attribute& value ()const ;

  Return the attribute representing the value of the definition.
  Version for constant object.

• Protected members:

  ValueDefinition (int,const char*,const char*) ;

  Constructor for exemplars.

  ValueDefinition (const string&,ValueDefinition*) ;

  Constructor for clones.

  const string itsPrefix ;

  The declaration prefix.
  A string representing the value type in MAD-9 input format: "BOOL", "REAL", "REAL CONST", "REAL VECTOR", etc.