Computer Assisted Medical Intervention Tool Kit  version 5.1
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 ()
 default constructor More...
 
 ValueEvent (const double v, const double d)
 constructor with initial values More...
 
void xmlPrint (std::ostream &)
 Print to an ostream. More...
 
 ~ValueEvent ()=default
 destructor 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() [1/2]

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

constructor with initial values

◆ ValueEvent() [2/2]

ValueEvent::ValueEvent ( )
inline

default constructor

◆ ~ValueEvent()

ValueEvent::~ValueEvent ( )
default

destructor

Member Function Documentation

◆ getDate()

double ValueEvent::getDate ( ) const

◆ getValue() [1/3]

double ValueEvent::getValue ( )

return the scalar value of the event

Referenced by Translation::ansysPrint(), and getValue().

◆ getValue() [2/3]

double ValueEvent::getValue ( const double  t)

return the scalar value of the event at time t

References getValue(), and isActive().

◆ getValue() [3/3]

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

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

References getDate(), getValue(), and isActive().

◆ isActive()

bool ValueEvent::isActive ( const double  t) const

return true if the event is active at time t

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

Referenced by getValue().

◆ setDate()

void ValueEvent::setDate ( const double  d)

set the value event date

◆ setValue()

void ValueEvent::setValue ( const double  v)

set the value event value

◆ xmlPrint()

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

Print to an ostream.

Referenced by Load::xmlPrint().

Friends And Related Function Documentation

◆ operator<<

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

print to an output stream in XML format.

See also
load.xsd the loadML XML schema

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