ciTrack Class Reference

Public Types
enum	PlayMode {   pause = 0, forwardPlay = 1, reversePlay = 2, forwardPause = 3,   reversePause = 4, beginPause = 5, endPause = 6 }

Public Member Functions
double	getStartTime ()
void	setStartTime (double time)
double	getEndTime ()
void	setEndTime (double time)
double	getIncrement ()
void	setIncrement (double time)
double	getFrameRate ()
void	setFrameRate (double rate)
double	getSpeed ()
void	setSpeed (double speed)
PlayMode	getPlayMode ()
void	setPlayMode (PlayMode flag)
bool	getLoopContinuous ()
void	setLoopContinuous (bool flag)
bool	getSaveFloat ()
void	setSaveFloat (bool flag)
double	getSimTime ()
void	setSimTime (double time)
int	getSaveFrameCount ()
void	setSaveFrameCount (int framecount)
bool	getSaveBmp ()
void	setSaveBmp (bool flag)
char *	getSaveFilePrefix ()
void	setSaveFilePrefix (char *name)
void	setLinkTOD (bool linkTOD)
bool	getLinkTOD ()
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *trackNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *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)
ciTrack	operator= (ciTrack &obj)
	ciTrack ()
	ciTrack (ciTrack &obj)
virtual	~ciTrack ()

Protected Attributes
double	m_startTime
double	m_endTime
double	m_speed
double	m_frameRate
double	m_increment
PlayMode	m_playMode
bool	m_loopContinuous
bool	m_saveFloat
bool	m_saveBmp
char	m_saveFilePrefix [255]
double	m_currentSimTime
int	m_saveFileCount
bool	m_linkTOD
clXMLNode *	m_parentNode

Detailed Description

ciTrack class declaration

Member Enumeration Documentation

enum ciTrack::PlayMode

Enumerator:

pause
forwardPlay
reversePlay
forwardPause
reversePause
beginPause
endPause

Constructor & Destructor Documentation

ciTrack::ciTrack

(

)

Default constructor.

ciTrack::ciTrack

(

ciTrack &

obj

)

Copy constructor.

Parameters

obj	- ciTrack object to be copied.

virtual ciTrack::~ciTrack ( )

virtual

Member Function Documentation

double ciTrack::getStartTime ( )

inline

gets the track start time.

Returns

The track start time.

void ciTrack::setStartTime ( double  time )

inline

sets the track start time.

Parameters

time	- The track start time to be assigned.

Returns

void.

double ciTrack::getEndTime ( )

inline

gets the track end time.

Returns

The track end time.

void ciTrack::setEndTime ( double  time )

inline

sets the track end time - the point at which the time is reset to 0 if playing forward.

Parameters

time	- The track end time to be assigned.

Returns

void.

double ciTrack::getIncrement ( )

inline

gets the increment amount that is added each rendered frame

Returns

The increment amount.

void ciTrack::setIncrement ( double  time )

inline

sets the increment amount that is added each rendered frame.

Parameters

time	- The increment amount to be assigned.

Returns

void.

double ciTrack::getFrameRate ( )

inline

gets the frame rate that used in movie playback

Returns

The frame rate amount.

void ciTrack::setFrameRate ( double  rate )

inline

sets the frame rate that used in movie playback

Parameters

rate	- The frame rate to be assigned.

Returns

void.

double ciTrack::getSpeed ( )

inline

gets the speed multiplier that is used in movie playback

Returns

The speed multiplier.

void ciTrack::setSpeed ( double  speed )

inline

sets the speed multiplier that is used in movie playback

Parameters

rate	- The speed multiplier.

Returns

void.

PlayMode ciTrack::getPlayMode ( )

inline

gets the play direction flag

Returns

The play direction flag.

void ciTrack::setPlayMode ( PlayMode  flag )

inline

sets the play direction flag

Parameters

flag	- The play direction flag to be assigned.

Returns

void.

bool ciTrack::getLoopContinuous ( )

inline

gets the loop continuous flag

Returns

The loop continuous flag.

void ciTrack::setLoopContinuous ( bool  flag )

inline

sets the loop continuous flag

Parameters

flag	- The loop continuous flag to be assigned.

Returns

void.

bool ciTrack::getSaveFloat ( )

inline

gets the save floating point images flag

Returns

The save floating point images flag.

void ciTrack::setSaveFloat ( bool  flag )

inline

sets the save floating point images flag

Parameters

flag	- The save floating point images flag to be assigned.

Returns

void.

Referenced by ciTrackControlPanel::setSaveFloat().

double ciTrack::getSimTime ( )

inline

gets the current simulation time set by SG thread

Returns

The save floating point images flag.

void ciTrack::setSimTime ( double  time )

inline

sets the simulation time

Parameters

time	the new simulation time set by SG thread

Returns

void.

int ciTrack::getSaveFrameCount ( )

inline

gets the current simulation time set by SG thread

Returns

The save floating point images flag.

void ciTrack::setSaveFrameCount ( int  framecount )

inline

sets the simulation time

Parameters

time	the new simulation time set by SG thread

Returns

void.

Referenced by ciTrackControlPanel::setSaveFrameCount().

bool ciTrack::getSaveBmp ( )

inline

gets the save 8 bit bmp images flag

Returns

The save 8 bit bmp images flag.

void ciTrack::setSaveBmp ( bool  flag )

inline

sets the save 8 bit bmp images flag

Parameters

flag	- The save 8 bit bmp images flag to be assigned.

Returns

void.

Referenced by ciTrackControlPanel::setSaveBmp().

char* ciTrack::getSaveFilePrefix

(

)

Gets the save filename prefix.

Returns

The save filename prefix.

void ciTrack::setSaveFilePrefix

(

char *

name

)

Sets the save filename prefix.

Parameters

name	- The save filename prefix.

Returns

void.

void ciTrack::setLinkTOD ( bool  linkTOD )

inline

Parameters

bool

linkTOD

bool ciTrack::getLinkTOD ( )

inline

Returns

bool

bool ciTrack::archive

(

std::ofstream &

outf

)

Description:

Saves the ciTrack object to file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciTrack::serialize

(

char *

filepath

)

Description:

Loads the ciTrack object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciTrack::loadXML

(

clXMLNode *

trackNode

)

bool ciTrack::parseXML

(

clXML &

xmlDocument

)

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

Parameters

std::string	tag
char	*nodeString

Returns

bool

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

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

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

Parameters

std::string	tag
int	*nodeBool

Returns

bool

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

Parameters

std::string	tag
double	*nodeBool

Returns

bool

void ciTrack::saveXML

(

clXML *

xmlDocument

)

ciTrack ciTrack::operator=

(

ciTrack &

obj

)

Assignment operator.

Parameters

obj	- ciTrack object to be assigned.

Returns

The assigned ciTrack object.

Member Data Documentation

double ciTrack::m_startTime

protected

Track file start time

double ciTrack::m_endTime

protected

Track file end time - time to restart time

double ciTrack::m_speed

protected

Track file speed multiplier

double ciTrack::m_frameRate

protected

Track file frame rate time

double ciTrack::m_increment

protected

Track file increment per frame

PlayMode ciTrack::m_playMode

protected

Track file global enable flag

bool ciTrack::m_loopContinuous

protected

Track file loop continuously flag

bool ciTrack::m_saveFloat

protected

Save floating point images flag

bool ciTrack::m_saveBmp

protected

Save 8 bit bmp images flag

char ciTrack::m_saveFilePrefix[255]

protected

file name prefix for saving files

double ciTrack::m_currentSimTime

protected

simulation time

int ciTrack::m_saveFileCount

protected

simulation framecount

bool ciTrack::m_linkTOD

protected

clXMLNode* ciTrack::m_parentNode

protected

---

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

• ciTrack.h