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
	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() [1/3]

TargetList::TargetList ( )

default

default constructor, the target list is empty

TargetList() [2/3]

TargetList::TargetList

(

const std::string

l

)

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")

References add().

TargetList() [3/3]

TargetList::TargetList

(

const TargetList &

t

)

create a target list using another one

References add(), and toString().

Member Function Documentation

add() [1/2]

void TargetList::add

(

const unsigned int

index

)

add a load using an integer

References indexedTargetList.

Referenced by add(), Load::addTarget(), and TargetList().

add() [2/2]

void TargetList::add

(

const std::string

s

)

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

References add(), isDigit, and namedTargetList.

clear()

void TargetList::clear

(

)

clear the list

References indexedTargetList, and namedTargetList.

getIndexedTarget()

int TargetList::getIndexedTarget

(

const unsigned int

targetIndex

)

const

get an indexed target

Returns

-1 if index out of bound or if targets are not indexed (i.e targets are named)

References indexedTargetList.

Referenced by AtomIterator::AtomIterator(), and Load::getTarget().

getNamedTarget()

std::string TargetList::getNamedTarget

(

const unsigned int

targetIndexInList

)

const

get a named target

Returns

"" if index out of bound or if targets are not named (i.e targets are indexed)

References namedTargetList.

Referenced by AtomIterator::AtomIterator().

getNumberOfTargets()

unsigned int TargetList::getNumberOfTargets

(

)

const

get the nr of indevidual targets

References indexedTargetList, indexedTargets(), and namedTargetList.

Referenced by AtomIterator::AtomIterator(), and Load::numberOfTargets().

indexedTargets()

bool TargetList::indexedTargets

(

)

const

return true only if the list of target are indexes

References indexedTargetList.

Referenced by AtomIterator::AtomIterator(), getNumberOfTargets(), toAnsys(), and toString().

isIn()

bool TargetList::isIn

(

unsigned int

id

)

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!

References indexedTargetList, and namedTargetList.

toAnsys()

std::string TargetList::toAnsys

(

)

const

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

References indexedTargetList, indexedTargets(), and toString().

Referenced by Load::ansysPrint().

toString()

std::string TargetList::toString

(

)

const

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

References indexedTargetList, indexedTargets(), and namedTargetList.

Referenced by TargetList(), toAnsys(), and Load::xmlPrint().

Member Data Documentation

indexedTargetList

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

private

list of indexed target = index of the entities

Referenced by add(), clear(), getIndexedTarget(), getNumberOfTargets(), indexedTargets(), isIn(), toAnsys(), and toString().

namedTargetList

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

private

list of named target = name of the entities

Referenced by add(), clear(), getNamedTarget(), getNumberOfTargets(), isIn(), and toString().

---

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

• TargetList.h
• TargetList.cpp