UserInterface Class Reference

#include <ui.h>

Inheritance diagram for UserInterface:

Public Member Functions
void	AddExternalType (const char *name, ExternalType *p)
void	AddExternalType (const std::string &name, ExternalType *p)
	UserInterface (int port, bool withUpdateControl=true)
	~UserInterface ()
void	SendUiNewState (const std::string &s, const char &c)
int	Step (bool &, SystemClockOffset *nextStepIn_ns=0)
	Return nonzero if a breakpoint was hit. More...
void	SwitchUpdateOnOff (bool PollFreq)
void	Write (const std::string &s)
Public Member Functions inherited from SimulationMember
virtual	~SimulationMember ()
Public Member Functions inherited from ExternalType
virtual	~ExternalType ()

Protected Member Functions
void	SetNewValueFromUi (const std::string &)

Protected Attributes
std::map< std::string, ExternalType * >	extMembers
bool	updateOn
SystemClockOffset	pollFreq
std::string	dummy
std::map< std::string, char >	LastState
int	waitOnAckFromTclRequest
int	waitOnAckFromTclDone

Additional Inherited Members
Private Member Functions inherited from Socket
	Socket (int port)
	~Socket ()
ssize_t	Read (std::string &a)
void	Write (const std::string &s)
ssize_t	Poll ()
void	Write (const char *in)

Detailed Description

Interfacing between "UI" application on TCP port and ExternalType objects which interface with device peripherals.

Definition at line 41 of file ui.h.

Constructor & Destructor Documentation

UserInterface()

UserInterface::UserInterface	(	int	port,
		bool	withUpdateControl = true
	)

Referenced by AddExternalType().

~UserInterface()

UserInterface::~UserInterface

(

)

Referenced by AddExternalType().

Member Function Documentation

AddExternalType() [1/2]

void UserInterface::AddExternalType ( const char *  name, ExternalType *  p  )

inline

Definition at line 54 of file ui.h.

Referenced by AddExternalType(), and TraceControl::TraceControl().

AddExternalType() [2/2]

void UserInterface::AddExternalType ( const std::string &  name, ExternalType *  p  )

inline

Definition at line 58 of file ui.h.

References AddExternalType(), SendUiNewState(), Step(), SwitchUpdateOnOff(), UserInterface(), Write(), and ~UserInterface().

SendUiNewState()

void UserInterface::SendUiNewState	(	const std::string &	s,
		const char &	c
	)

Referenced by AddExternalType().

SetNewValueFromUi()

void UserInterface::SetNewValueFromUi ( const std::string &  )

protectedvirtual

Implements ExternalType.

Step()

int UserInterface::Step ( bool &  trueHwStep, SystemClockOffset *  timeToNextStepIn_ns = 0  )

virtual

Return nonzero if a breakpoint was hit.

Implements SimulationMember.

Referenced by AddExternalType().

SwitchUpdateOnOff()

void UserInterface::SwitchUpdateOnOff

(

bool

PollFreq

)

Referenced by AddExternalType().

Write()

void UserInterface::Write

(

const std::string &

s

)

Referenced by AddExternalType(), and TraceControl::TraceControl().

Member Data Documentation

dummy

std::string UserInterface::dummy

protected

Definition at line 46 of file ui.h.

extMembers

std::map<std::string, ExternalType*> UserInterface::extMembers

protected

Definition at line 43 of file ui.h.

LastState

std::map<std::string, char> UserInterface::LastState

protected

Definition at line 47 of file ui.h.

pollFreq

SystemClockOffset UserInterface::pollFreq

protected

Definition at line 45 of file ui.h.

updateOn

bool UserInterface::updateOn

protected

Definition at line 44 of file ui.h.

waitOnAckFromTclDone

int UserInterface::waitOnAckFromTclDone

protected

Definition at line 49 of file ui.h.

waitOnAckFromTclRequest

int UserInterface::waitOnAckFromTclRequest

protected

Definition at line 48 of file ui.h.

---

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

• /home/buildbudy/simulavr/include/ui/ui.h