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

Manage a list of targets, can be created/modified using either an integer, a name, a list of integers given in a string (e.g. More...

#include <TargetList.h>

Public Member Functions

void add (const unsigned int)
 add a load using an integer More...
 
void add (const std::string)
 add a load using a list (either an indexed list or a named list) More...
 
void clear ()
 clear the list More...
 
int getIndexedTarget (const unsigned int) const
 get an indexed target More...
 
std::string getNamedTarget (const unsigned int) const
 get a named target More...
 
unsigned int getNumberOfTargets () const
 get the nr of indevidual targets More...
 
bool indexedTargets () const
 return true only if the list of target are indexes More...
 
bool isIn (unsigned int) const
 return true only if this is the list of target are indexes and the given index is in the list or if the name of the entities is star! More...
 
 TargetList ()
 default constructor, the target list is empty More...
 
 TargetList (const std::string)
 create a target list using initial list of targets. More...
 
 TargetList (const TargetList &)
 create a target list using another one More...
 
std::string toAnsys () const
 return the ANSYS command to select the list of target (only work for indexed targets) More...
 
std::string toString () const
 return the list in a handy/compact format (compact interval, i.e. 4,5,6 becomes 4-6, ...) More...
 

Private Attributes

std::vector< unsigned int > indexedTargetList
 list of indexed target = index of the entities More...
 
std::vector< std::string > namedTargetList
 list of named target = name of the entities More...
 

Detailed Description

Manage a list of targets, can be created/modified using either an integer, a name, a list of integers given in a string (e.g.

"1,3,5,10-15"), or a list of names given in a string (e.g. "componentA,componentB").

Note
Mixed (indexed/named) are not supported (yet?)

Constructor & Destructor Documentation

TargetList::TargetList ( )

default constructor, the target list is empty

TargetList::TargetList ( const std::string  )

create a target list using initial list of targets.

The list of targets can be either a indexed list (eg. "5-7,10,12-15") or a named list (eg. "componentA,componentB")

TargetList::TargetList ( const TargetList )

create a target list using another one

Member Function Documentation

void TargetList::add ( const unsigned  int)

add a load using an integer

void TargetList::add ( const std::string  )

add a load using a list (either an indexed list or a named list)

void TargetList::clear ( )

clear the list

int TargetList::getIndexedTarget ( const unsigned  int) const

get an indexed target

Returns
-1 if index out of bound or if targets are not indexed (i.e targets are named)
std::string TargetList::getNamedTarget ( const unsigned  int) const

get a named target

Returns
"" if index out of bound or if targets are not named (i.e targets are indexed)
unsigned int TargetList::getNumberOfTargets ( ) const

get the nr of indevidual targets

bool TargetList::indexedTargets ( ) const

return true only if the list of target are indexes

bool TargetList::isIn ( unsigned  int) const

return true only if this is the list of target are indexes and the given index is in the list or if the name of the entities is star!

std::string TargetList::toAnsys ( ) const

return the ANSYS command to select the list of target (only work for indexed targets)

std::string TargetList::toString ( ) const

return the list in a handy/compact format (compact interval, i.e. 4,5,6 becomes 4-6, ...)

Member Data Documentation

std::vector<unsigned int> TargetList::indexedTargetList
private

list of indexed target = index of the entities

std::vector<std::string> TargetList::namedTargetList
private

list of named target = name of the entities


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