Computer Assisted Medical Intervention Tool Kit  version 6.0
Loading...
Searching...
No Matches
Loads Class Reference

This class makes it possible to manage a list of "Load". More...

#include <Loads.h>

Public Member Functions

void addLoad (Load *ld)
 add a load to the list
void ansysPrint (std::ostream &) const
 Print the load list in ansys format (BEWARE: not everything is implemented).
void deleteLoad (const unsigned int i)
 delete a load and remove it from the list using its index
double getFirstEventDate ()
 get the first event date present in the list of loads
double getLastEventDate ()
 get the last event date present in the list of loads
LoadgetLoad (const unsigned int i) const
 get a load by its index in the list
 Loads ()=default
 default constructor
 Loads (std::string)
 build a list of load from an LML file
unsigned int numberOfLoads () const
 get the number of "Load" stored in the list
void xmlPrint (std::ostream &) const
 Print to an ostream.
void xmlRead (std::string filename)
 read the input xml file using xsd and instantiate the loads
 ~Loads ()
 destructor

Static Public Attributes

static const char * VERSION
 current version of the library

Friends

std::ostream & operator<< (std::ostream &o, const Loads l)
 print to an output stream in XML format.

Detailed Description

This class makes it possible to manage a list of "Load".

Remember that Load is an abstract class (concrete instances are in instances of Translation, Force...etc)

Usage example:

 // reading:
 main()
 {
     Loads allLoads("myFile.lml");
     ...
     cout << allLoads;
 }

 // creating and writing:
 main()
 {
     Loads allLoads;
     Translation *t = new Translation();
     t->setUnit(..);
     ...
     allLoads->addLoad(t);
     ...
     cout << allLoads;
 }
 
Note
All loads that are added to an object of this class are then taking over by it (i.e. when an object of this class is deleted, it will delete all its loads).

Constructor & Destructor Documentation

◆ Loads() [1/2]

Loads::Loads ( )
default

default constructor

References Loads().

Referenced by Loads(), and operator<<.

◆ Loads() [2/2]

Loads::Loads ( std::string fileName)

build a list of load from an LML file

References xmlRead().

◆ ~Loads()

Loads::~Loads ( )

destructor

Member Function Documentation

◆ addLoad()

void Loads::addLoad ( Load * ld)

add a load to the list

Referenced by xmlRead().

◆ ansysPrint()

void Loads::ansysPrint ( std::ostream & o) const

Print the load list in ansys format (BEWARE: not everything is implemented).

References Load::ansysPrint(), getLoad(), Load::getType(), and numberOfLoads().

◆ deleteLoad()

void Loads::deleteLoad ( const unsigned int i)

delete a load and remove it from the list using its index

◆ getFirstEventDate()

double Loads::getFirstEventDate ( )

get the first event date present in the list of loads

Returns
-1.0 if no events are found

References ValueEvent::getDate().

◆ getLastEventDate()

double Loads::getLastEventDate ( )

get the last event date present in the list of loads

Returns
-1.0 if no events are found

References ValueEvent::getDate().

◆ getLoad()

Load * Loads::getLoad ( const unsigned int i) const

get a load by its index in the list

Referenced by ansysPrint(), operator<<, TranslationConstraint< DataTypes >::TranslationConstraint(), and xmlPrint().

◆ numberOfLoads()

unsigned int Loads::numberOfLoads ( ) const

get the number of "Load" stored in the list

Referenced by ansysPrint(), operator<<, TranslationConstraint< DataTypes >::TranslationConstraint(), and xmlPrint().

◆ xmlPrint()

void Loads::xmlPrint ( std::ostream & o) const

Print to an ostream.

print the prolog of the xml file

References getLoad(), numberOfLoads(), and Load::xmlPrint().

◆ xmlRead()

◆ operator<<

std::ostream & operator<< ( std::ostream & o,
const Loads l )
friend

print to an output stream in XML format.

See also
Loads.xsd

References getLoad(), Loads(), and numberOfLoads().

Member Data Documentation

◆ VERSION

const char* Loads::VERSION
static

current version of the library


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