xc
Public Member Functions | List of all members

Linear function over time. More...

#include <LinearSeries.h>

Inheritance diagram for XC::LinearSeries:
XC::CFactorSeries XC::TimeSeries XC::MovableObject XC::DistributedBase

Public Member Functions

 LinearSeries (double cFactor=1.0)
 Constructor. More...
 
TimeSeriesgetCopy (void) const
 Virtual constructor.
 
double getFactor (double pseudoTime) const
 Returns the load factor at the specified time (product of cFactor and pseudoTime). More...
 
double getDuration (void) const
 
double getPeakFactor (void) const
 
double getTimeIncr (double pseudoTime) const
 
void Print (std::ostream &s, int flag=0) const
 Print stuff.
 
- Public Member Functions inherited from XC::CFactorSeries
 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.
 
void setFactor (const double &d)
 Sets factor value.
 
- Public Member Functions inherited from XC::TimeSeries
 TimeSeries (int classTag)
 Constructor. More...
 
virtual int setParameter (const std::vector< std::string > &argv, Parameter &param)
 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.
 
MovableObjectoperator= (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.
 

Additional Inherited Members

- Protected Member Functions inherited from XC::CFactorSeries
DbTagDatagetDbTagData (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 inherited from XC::CFactorSeries
double cFactor
 factor that multiplies series values.
 

Detailed Description

Linear function over time.

Objects of this class represent a linear relationship between the pseudo time and the load factor.

Constructor & Destructor Documentation

§ LinearSeries()

XC::LinearSeries::LinearSeries ( double  theFactor = 1.0)

Constructor.

Parameters
theFactorfactor used in the relation.

Member Function Documentation

§ getFactor()

double XC::LinearSeries::getFactor ( double  pseudoTime) const
virtual

Returns the load factor at the specified time (product of cFactor and pseudoTime).

Reimplemented from XC::CFactorSeries.


The documentation for this class was generated from the following files: