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 ()=default
	destructor More...

Private Attributes
double	date {0.0}
	actual date More...
double	value {0.0}
	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() [1/2]

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

inline

constructor with initial values

ValueEvent() [2/2]

ValueEvent::ValueEvent ( )

inline

default constructor

References getDate(), getValue(), isActive(), operator<<, setDate(), setValue(), xmlPrint(), and ~ValueEvent().

~ValueEvent()

ValueEvent::~ValueEvent ( )

default

destructor

Referenced by ValueEvent().

Member Function Documentation

getDate()

double ValueEvent::getDate

(

)

const

double get start time

References date.

Referenced by Loads::getFirstEventDate(), Loads::getLastEventDate(), getValue(), Load::getValue(), std::greater< ValueEvent * >::operator()(), operator<<(), and ValueEvent().

getValue() [1/3]

double ValueEvent::getValue

(

)

return the scalar value of the event

References value.

Referenced by Translation::ansysPrint(), getValue(), operator<<(), and ValueEvent().

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

References date.

Referenced by getValue(), and ValueEvent().

setDate()

void ValueEvent::setDate

(

const double

d

)

set the value event date

References date.

Referenced by ValueEvent().

setValue()

void ValueEvent::setValue

(

const double

v

)

set the value event value

References value.

Referenced by ValueEvent().

xmlPrint()

void ValueEvent::xmlPrint

(

std::ostream &

o

)

Print to an ostream.

References date, and value.

Referenced by ValueEvent(), and 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

Referenced by ValueEvent().

Member Data Documentation

date

double ValueEvent::date {0.0}

private

actual date

Referenced by getDate(), isActive(), setDate(), and xmlPrint().

value

double ValueEvent::value {0.0}

private

actual value

Referenced by getValue(), setValue(), and xmlPrint().

---

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

• ValueEvent.h
• ValueEvent.cpp