Origen Namespace Reference

Namespaces
	TestMethod
	Time
	Utils

Classes
class	Site

Functions
void	logParametricTest (string name, int site, double result, LIMIT limits, string pin)
	Prints the result of a parametric test to the console. More...
LIMIT	noLimits ()
	Returns a LIMIT object with no limits enabled. More...
void	logFunctionalTest (string name, int site, bool passed, string pattern)
	Prints the result of a functional test to the console. More...
string	loStr (LIMIT limits)
string	hiStr (LIMIT limits)
bool	isPass (double val, LIMIT limits)
	Returns true if the result is within the given limits. More...
uint64_t	flip (uint64_t input, int size)
vector< string >	split (const string &str, char delim)
void	split (const string &str, char delim, vector< string > &elems)
string	ltrim (string str, const char *remove_chars)
string	rtrim (string str, const char *remove_chars)
string	trim (string str, const char *remove_chars)
int64_t	toInt (string str, int base)
uint64_t	toUInt (string str, int base)
	See toInt, but returns an unsigned 64-bit integer. More...
string	toHex (const uint64_t &val)
string	toStr (const uint64_t &val)
string	upcase (string base)
string	downcase (string base)
string	lpad (string base, int length, char fill)
string	rpad (string base, int length, char fill)
bool	isEven (uint64_t number)
	Returns true if the given number is even. More...
bool	isOdd (uint64_t number)
	Returns true if the given number is odd. More...
void	overlaySubroutineOutput (string subroutinePattern, string pin, uint64_t data, int size, int loOutputIndex, int hiOutputIndex)
void	overlaySubroutine (string subroutinePattern, string pin, uint64_t data, int size)
void	reverseOverlaySubroutine (string subroutinePattern, string pin, uint64_t data, int size)
	Same as overlaySubroutine but the data is applied in reverse order. More...
int	numberOfOnes (uint32_t i)
	Returns the number of 1's (bits that are set) in the given 32-bit number. More...
int	numberOfZeros (uint32_t i)
	Returns the number of 0's (bits that are not set) in the given 32-bit number. More...
double	calculateFrequency (const ARRAY_I &captureData, double periodInNs)
double	calculatePeriod (const ARRAY_I &captureData, double periodInNs)
void	synchronize (double timeout)
bool	pinExists (const string &pinName)
string	extractPinsFromGroup (const string &groupname)
	Supply a pin alias name and get the name of the physical pin returned. More...
void	initializeSites ()
double	getUnitMultiplier (const string &units)
string	getLabelFromBurst (const string &burst, const string &port)
string	checksum16bits (const string &mystring)
Utils::Version	version ()
Site &	site ()
Site &	site (int site)

Variables
vector< Site >	Sites
bool	invertFunctionalResults = false

Function Documentation

double Origen::calculateFrequency	(	const ARRAY_I &	captureData,
		double	periodInNs
	)

double Origen::calculatePeriod	(	const ARRAY_I &	captureData,
		double	periodInNs
	)

string Origen::checksum16bits

(

const string &

mystring

)

string Origen::downcase

(

string

base

)

Lowercase the given string

downcase("FF"); // => "ff"

string Origen::extractPinsFromGroup

(

const string &

groupname

)

Supply a pin alias name and get the name of the physical pin returned.

uint64_t Origen::flip	(	uint64_t	input,
		int	size
	)

string Origen::getLabelFromBurst	(	const string &	burst,
		const string &	port
	)

double Origen::getUnitMultiplier

(

const string &

units

)

string Origen::hiStr

(

LIMIT

limits

)

Converts the high limit in the given LIMIT object into a string, where an empty string will be returned if the limit is not enabled

void Origen::initializeSites

(

)

bool Origen::isEven

(

uint64_t

number

)

Returns true if the given number is even.

bool Origen::isOdd

(

uint64_t

number

)

Returns true if the given number is odd.

bool Origen::isPass	(	double	val,
		LIMIT	limits
	)

Returns true if the result is within the given limits.

void Origen::logFunctionalTest	(	string	name,
		int	site,
		bool	passed,
		string	pattern
	)

Prints the result of a functional test to the console.

void Origen::logParametricTest	(	string	name,
		int	site,
		double	result,
		LIMIT	limits,
		string	pin
	)

Prints the result of a parametric test to the console.

string Origen::loStr

(

LIMIT

limits

)

Converts the low limit in the given LIMIT object into a string, where an empty string will be returned if the limit is not enabled

string Origen::lpad	(	string	base,
		int	length,
		char	fill
	)

Extend the string to the given size, padding with the given character on the left

lpad("FF", 4, '0'); // => "00FF"

string Origen::ltrim	(	string	str,
		const char *	remove_chars
	)

LIMIT Origen::noLimits

(

)

Returns a LIMIT object with no limits enabled.

int Origen::numberOfOnes

(

uint32_t

i

)

Returns the number of 1's (bits that are set) in the given 32-bit number.

int Origen::numberOfZeros

(

uint32_t

i

)

Returns the number of 0's (bits that are not set) in the given 32-bit number.

void Origen::overlaySubroutine	(	string	subroutinePattern,
		string	pin,
		uint64_t	data,
		int	size
	)

Overlays the given data on the given pin, starting from the first vector of the given pattern

void Origen::overlaySubroutineOutput	(	string	subroutinePattern,
		string	pin,
		uint64_t	data,
		int	size,
		int	loOutputIndex,
		int	hiOutputIndex
	)

Overlays the given data on the given pin, starting from the first vector of the given pattern must provide the waveform indices used for output high and low

bool Origen::pinExists

(

const string &

pinName

)

void Origen::reverseOverlaySubroutine	(	string	subroutinePattern,
		string	pin,
		uint64_t	data,
		int	size
	)

Same as overlaySubroutine but the data is applied in reverse order.

string Origen::rpad	(	string	base,
		int	length,
		char	fill
	)

Extend the string to the given size, padding with the given character on the right

rpad("FF", 4, ' '); // => "FF "

string Origen::rtrim	(	string	str,
		const char *	remove_chars
	)

Site & Origen::site

(

)

Site & Origen::site

(

int

site

)

vector< string > Origen::split	(	const string &	str,
		char	delim
	)

Split the given string by the given delimiter and return the results in a vector of strings

split("AB1234-24", '-') // => ["AB1234", "24"]

void Origen::split	(	const string &	str,
		char	delim,
		vector< string > &	elems
	)

This version places the result in the supplied vector rather than returning a new one

void Origen::synchronize

(

double

timeout

)

Call to wait for all SMC threads to complete, supply the max amount of seconds to wait

string Origen::toHex

(

const uint64_t &

val

)

Convert the given number to a hex string

toHex(255); // => "ff"

int64_t Origen::toInt	(	string	str,
		int	base
	)

Convert the given string to a 64-bit integer. Works for both decimal and hex strings as shown in the examples below.

If the string is not successfully converted the site in focus will be binned out.

toInt("0xFF") // => 255 toInt("FF", 16) // => 255 (must declare base 16 if no leading 0x) toInt("255") // => 255

string Origen::toStr

(

const uint64_t &

val

)

Convert the given number to a string

toStr(255); // => "255"

uint64_t Origen::toUInt	(	string	str,
		int	base
	)

See toInt, but returns an unsigned 64-bit integer.

string Origen::trim	(	string	str,
		const char *	remove_chars
	)

string Origen::upcase

(

string

base

)

Uppercase the given string

upcase("ff"); // => "FF"

Utils::Version Origen::version

(

)

Variable Documentation

bool Origen::invertFunctionalResults = false

vector< Site > Origen::Sites