Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | Friends | List of all members
ValueEvent Class Reference

A valueEvent of a load is composed of a value and a date. More...

#include <ValueEvent.h>

Public Member Functions

double getDate () const
 double get start time More...
 
double getValue ()
 return the scalar value of the event More...
 
double getValue (const double t)
 return the scalar value of the event at time t More...
 
double getValue (const double t, ValueEvent *nextE)
 return the scalar value of the event at time t, knowing that next event is nextE More...
 
bool isActive (const double t) const
 return true if the event is active at time t More...
 
void setDate (const double)
 set the value event date More...
 
void setValue (const double)
 set the value event value More...
 
 ValueEvent (const double v, const double d)
 constructor with initial values More...
 
 ValueEvent ()
 default constructor More...
 
void xmlPrint (std::ostream &)
 Print to an ostream. More...
 
 ~ValueEvent ()
 destructor More...
 

Private Attributes

double date
 actual date More...
 
double value
 actual value More...
 

Friends

std::ostream & operator<< (std::ostream &, ValueEvent)
 print to an output stream in XML format. More...
 

Detailed Description

A valueEvent of a load is composed of a value and a date.

Constructor & Destructor Documentation

ValueEvent::ValueEvent ( const double  v,
const double  d 
)
inline

constructor with initial values

ValueEvent::ValueEvent ( )
inline

default constructor

ValueEvent::~ValueEvent ( )
inline

destructor

Member Function Documentation

double ValueEvent::getDate ( ) const

double get start time

double ValueEvent::getValue ( )

return the scalar value of the event

double ValueEvent::getValue ( const double  t)

return the scalar value of the event at time t

double ValueEvent::getValue ( const double  t,
ValueEvent nextE 
)

return the scalar value of the event at time t, knowing that next event is nextE

bool ValueEvent::isActive ( const double  t) const

return true if the event is active at time t

void ValueEvent::setDate ( const double  )

set the value event date

void ValueEvent::setValue ( const double  )

set the value event value

void ValueEvent::xmlPrint ( std::ostream &  )

Print to an ostream.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ,
ValueEvent   
)
friend

print to an output stream in XML format.

See Also
load.xsd the loadML XML schema

Member Data Documentation

double ValueEvent::date
private

actual date

double ValueEvent::value
private

actual value


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