Base class for constant factor time series. More...
#include <CFactorSeries.h>
Inheritance diagram for XC::CFactorSeries:
Public Member Functions | |
| CFactorSeries (int classTag, double cf=1.0) | |
| Constructor. More... | |
| int | sendSelf (CommParameters &) |
| Sends object through the channel being passed as parameter. | |
| int | recvSelf (const CommParameters &) |
| Receives object through the channel being passed as parameter. | |
| double | getFactor (double pseudoTime) const |
| Return load factor at specified time. | |
| void | setFactor (const double &d) |
| Sets factor value. | |
 Public Member Functions inherited from XC::TimeSeries | |
| TimeSeries (int classTag) | |
| Constructor. More... | |
| virtual TimeSeries * | getCopy (void) const =0 |
| Virtual constructor. | |
| virtual double | getDuration (void) const =0 |
| virtual double | getPeakFactor (void) const =0 |
| virtual double | getTimeIncr (double pseudoTime) const =0 |
| virtual void | Print (std::ostream &s, int flag=0) const =0 |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
Sets the value param to the parameter argv. | |
| virtual int | updateParameter (int parameterID, Information &info) |
Updates the parameter identified by parameterID with info. | |
| virtual int | activateParameter (int parameterID) |
Activates the parameter identified by parameterID. | |
| virtual double | getFactorSensitivity (double pseudoTime) |
| Public Member Functions inherited from XC::MovableObject | |
| MovableObject (int classTag, int dbTag) | |
| Constructor. More... | |
| MovableObject (int classTag) | |
| Constructor. More... | |
| MovableObject (const MovableObject &) | |
| Copy constructor. Doesn't copy the dbTag. | |
| MovableObject & | operator= (const MovableObject &) |
| Assignment operator. Doesn't copy the dbTag. | |
| int | getClassTag (void) const |
| Return the class identifier. | |
| int | getDbTag (void) const |
| Return the object identifier in the database. | |
| int | getDbTag (CommParameters &) |
| Return the object identifier in the database. | |
| void | setDbTag (int dbTag) |
| Sets the object identifier in the database. | |
| void | setDbTag (CommParameters &) |
| Sets the object identifier in the database if not already set. More... | |
| virtual int | setVariable (const std::string &variable, Information &) |
Set the value of the variable idenfified by var. | |
| virtual int | getVariable (const std::string &variable, Information &) |
Return the value of the variable idenfified by var. | |
| Public Member Functions inherited from XC::DistributedBase | |
| DistributedBase (void) | |
| Constructor. | |
| const int & | getDbTagDataPos (const int &i) const |
| Returns the data at the i-th position. | |
| void | setDbTagDataPos (const int &i, const int &v) |
| Sets the data at the i-th position. | |
| void | inicComm (const int &dataSize) const |
| Initializes communication. | |
Protected Member Functions | |
| DbTagData & | getDbTagData (void) const |
| Returns a vector to store the dbTags of the class members. More... | |
| int | sendData (CommParameters &cp) |
| Send object members through the channel being passed as parameter. | |
| int | recvData (const CommParameters &cp) |
| Receives object members through the channel being passed as parameter. | |
Protected Attributes | |
| double | cFactor |
| factor that multiplies series values. | |
Detailed Description
Base class for constant factor time series.
Constructor & Destructor Documentation
§ CFactorSeries()
| XC::CFactorSeries::CFactorSeries | ( | int | classTag, |
| double | theFactor = 1.0 |
||
| ) |
Constructor.
- Parameters
-
theFactor factor used in the relation.
Member Function Documentation
§ getDbTagData()
|
protectedvirtual |
Returns a vector to store the dbTags of the class members.
Reimplemented from XC::DistributedBase.
The documentation for this class was generated from the following files:
- src/domain/load/pattern/time_series/CFactorSeries.h
- src/domain/load/pattern/time_series/CFactorSeries.cc
