Core::FMTSerie Class Reference

Class keeping the information of a serie of actions in a given order. More...

#include <FMTSerie.h>

Public Member Functions
	FMTSerie ()
	Default constructor for FMTSerie.
	FMTSerie (const std::string &p_serie, int p_length)
	Initialize a serie from a string description.
	FMTSerie (const std::vector< std::string > &p_serie, int p_length)
	Initialize a serie from a vector of strings.
	FMTSerie (const std::vector< std::string > &p_serie, bool p_asap, bool p_alap)
	Initialize a serie from a vector of strings with ASAP and ALAP flags.
int	getLength () const
	Return the length of the serie.
const std::vector< std::string > &	getActions () const
	Return the actions of the serie.
const std::string	getSerie () const
	Return the string of the serie.
	operator std::string () const
	return in string format
bool	operator== (const FMTSerie &p_RHS) const
	Equality comparison operator of FMTSerie.
bool	operator!= (const FMTSerie &p_RHS) const
	Inequality comparison operator of FMTSerie.
bool	operator< (const FMTSerie &p_RHS) const
	Less than comparison operator of FMTSerie.
bool	operator> (const FMTSerie &p_RHS) const
	Greater than comparison operator of FMTSerie.
bool	isASAP () const
	Return true if the serie is as soon as possible.
bool	isALAP () const
	Return true if the serie is as late as possible.
bool	isAllowedInSerie (const std::vector< std::string > &p_SerieMask) const
	Return true if the given actions are allowed in the serie.
bool	isEmpty () const
	Return true if the serie is empty.

Detailed Description

Class keeping the information of a serie of actions in a given order.

Constructor & Destructor Documentation

FMTSerie() [1/4]

Core::FMTSerie::FMTSerie

(

)

Default constructor for FMTSerie.

FMTSerie() [2/4]

Core::FMTSerie::FMTSerie	(	const std::string &	p_serie,
		int	p_length
	)

Initialize a serie from a string description.

Parameters

[in]	p_serie	the serie string.
[in]	p_length	the length of the serie in periods.

FMTSerie() [3/4]

Core::FMTSerie::FMTSerie	(	const std::vector< std::string > &	p_serie,
		int	p_length
	)

Initialize a serie from a vector of strings.

Parameters

[in]	p_serie	the serie strings.
[in]	p_length	the length of the serie in periods.

FMTSerie() [4/4]

Core::FMTSerie::FMTSerie	(	const std::vector< std::string > &	p_serie,
		bool	p_asap,
		bool	p_alap
	)

Initialize a serie from a vector of strings with ASAP and ALAP flags.

Parameters

[in]	p_serie	the serie strings.
[in]	p_asap	if true the serie is as soon as possible.
[in]	p_alap	if true the serie is as late as possible.

Member Function Documentation

getActions()

const std::vector< std::string > & Core::FMTSerie::getActions

(

)

const

Return the actions of the serie.

Returns

the actions of the serie.

getLength()

int Core::FMTSerie::getLength

(

)

const

Return the length of the serie.

Returns

the length of the serie.

getSerie()

const std::string Core::FMTSerie::getSerie

(

)

const

Return the string of the serie.

Returns

the string of the serie.

isALAP()

bool Core::FMTSerie::isALAP

(

)

const

Return true if the serie is as late as possible.

Returns

true if the serie is as late as possible else false.

isAllowedInSerie()

bool Core::FMTSerie::isAllowedInSerie

(

const std::vector< std::string > &

p_SerieMask

)

const

Return true if the given actions are allowed in the serie.

Parameters

[in]

p_SerieMask

the serie mask.

Returns

true if the actions are allowed in the serie else false.

isASAP()

bool Core::FMTSerie::isASAP

(

)

const

Return true if the serie is as soon as possible.

Returns

true if the serie is as soon as possible else false.

isEmpty()

bool Core::FMTSerie::isEmpty

(

)

const

Return true if the serie is empty.

Returns

true if the serie is empty else false.

operator std::string()

Core::FMTSerie::operator std::string

(

)

const

return in string format

Returns

string formated with _ASAP _ALAP

operator!=()

bool Core::FMTSerie::operator!=

(

const FMTSerie &

p_RHS

)

const

Inequality comparison operator of FMTSerie.

Parameters

[in]

p_RHS

the serie to compare with.

Returns

true if both series are different else false.

operator<()

bool Core::FMTSerie::operator<

(

const FMTSerie &

p_RHS

)

const

Less than comparison operator of FMTSerie.

Parameters

[in]

p_RHS

the serie to compare with.

Returns

true if this serie is less than p_RHS else false.

operator==()

bool Core::FMTSerie::operator==

(

const FMTSerie &

p_RHS

)

const

Equality comparison operator of FMTSerie.

Parameters

[in]

p_RHS

the serie to compare with.

Returns

true if both series are equal else false.

operator>()

bool Core::FMTSerie::operator>

(

const FMTSerie &

p_RHS

)

const

Greater than comparison operator of FMTSerie.

Parameters

[in]

p_RHS

the serie to compare with.

Returns

true if this serie is greater than p_RHS else false.

---

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

• D:/FMT/Include/FMTSerie.h