ciSystemTest Class Reference

Public Member Functions
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *environmentNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, std::string *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeBool)
bool	loadXMLNode (std::string tag, double *nodeBool)
void	saveXML (clXML *xmlDocument)
	ciSystemTest (void)
	~ciSystemTest (void)
	ciSystemTest (ciSystemTest &obj)
ciSystemTest	operator= (ciSystemTest &obj)
void	setCaptureFrame (int frame)
int	getCaptureFrame ()
void	setPreApertureFpf (std::string fname)
std::string	getPreApertureFpf ()
void	setPostApertureFpf (std::string fname)
std::string	getPostApertureFpf ()
void	setOutputImageArrayType (int type)
	sets the desired output type for fpf saves.
int	getOutputImageArrayType () const
	gets the desired output type for fpf saves.
void	setCaptureStandardOutput (bool state)
bool	getCaptureStandardOutput ()
void	setCaptureDisplayFrameRate (bool state)
bool	getCaptureDisplayFrameRate ()

Private Attributes
int	m_captureFrame
char *	m_preApertureFpf
char *	m_postApertureFpf
bool	m_standardOutput
bool	m_displayFrameRate
int	m_outputImageArrayType
clXMLNode *	m_parentNode

Constructor & Destructor Documentation

ciSystemTest::ciSystemTest

(

void

)

Description:

Default constructor.

ciSystemTest::~ciSystemTest

(

void

)

Description:

Default destructor.

ciSystemTest::ciSystemTest

(

ciSystemTest &

obj

)

Description:

Copy constructor.

Parameters

obj	- the object being copied.

Member Function Documentation

bool ciSystemTest::archive

(

std::ofstream &

outf

)

Description:

Saves the ciSystemTest object to file.

Parameters

filepath	- complete path and filename to the file
flags	- file io flags to be set.

Returns

true if sucessful

bool ciSystemTest::serialize

(

char *

filepath

)

Description:

Loads the ciSystemTest object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciSystemTest::loadXML

(

clXMLNode *

environmentNode

)

bool ciSystemTest::parseXML

(

clXML &

xmlDocument

)

bool ciSystemTest::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns

bool

bool ciSystemTest::loadXMLNode	(	std::string	tag,
		std::string *	nodeString
	)

Parameters

std::string	tag
std::string	*nodeString

Returns

bool

bool ciSystemTest::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

bool ciSystemTest::loadXMLNode	(	std::string	tag,
		int *	nodeBool
	)

Parameters

std::string	tag
int	*nodeBool

Returns

bool

bool ciSystemTest::loadXMLNode	(	std::string	tag,
		double *	nodeBool
	)

Parameters

std::string	tag
double	*nodeBool

Returns

bool

void ciSystemTest::saveXML

(

clXML *

xmlDocument

)

ciSystemTest ciSystemTest::operator=

(

ciSystemTest &

obj

)

Description:

Assignment operator.

Parameters

obj	- the object being assigned.

void ciSystemTest::setCaptureFrame ( int  frame )

inline

int ciSystemTest::getCaptureFrame ( )

inline

void ciSystemTest::setPreApertureFpf ( std::string  fname )

inline

std::string ciSystemTest::getPreApertureFpf ( )

inline

void ciSystemTest::setPostApertureFpf ( std::string  fname )

inline

std::string ciSystemTest::getPostApertureFpf ( )

inline

void ciSystemTest::setOutputImageArrayType ( int  type )

inline

sets the desired output type for fpf saves.

0 for Default is standard radiance output type, 1 for photons/sec, 2 for counts

int ciSystemTest::getOutputImageArrayType ( ) const

inline

gets the desired output type for fpf saves.

0 for Default is standard radiance output type, 1 for photons/sec, 2 for counts

void ciSystemTest::setCaptureStandardOutput ( bool  state )

inline

bool ciSystemTest::getCaptureStandardOutput ( )

inline

void ciSystemTest::setCaptureDisplayFrameRate ( bool  state )

inline

bool ciSystemTest::getCaptureDisplayFrameRate ( )

inline

Member Data Documentation

int ciSystemTest::m_captureFrame

private

char* ciSystemTest::m_preApertureFpf

private

char* ciSystemTest::m_postApertureFpf

private

bool ciSystemTest::m_standardOutput

private

bool ciSystemTest::m_displayFrameRate

private

int ciSystemTest::m_outputImageArrayType

private

clXMLNode* ciSystemTest::m_parentNode

private

---

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

• ciSystemTest.h