Retro::RtclRlinkPort Class Reference

FIXME_docs. More...

#include <RtclRlinkPort.hpp>

Inheritance diagram for Retro::RtclRlinkPort:

Collaboration diagram for Retro::RtclRlinkPort:

Public Member Functions
	RtclRlinkPort (Tcl_Interp *interp, const char *name)
	Default constructor.
	~RtclRlinkPort ()
	Destructor.
Public Member Functions inherited from Retro::RtclProxyBase
	RtclProxyBase (const std::string &type=std::string())
	FIXME_docs.
	RtclProxyBase (const std::string &type, Tcl_Interp *interp, const char *name)
	FIXME_docs.
virtual	~RtclProxyBase ()
	Destructor.
virtual int	ClassCmdConfig (RtclArgs &args)
	FIXME_docs.
const std::string &	Type () const
	FIXME_docs.
Tcl_Command	Token () const
	FIXME_docs.
std::string	CommandName () const
	FIXME_docs.
Public Member Functions inherited from Retro::RtclCmdBase
	RtclCmdBase ()
	FIXME_docs.
virtual	~RtclCmdBase ()
	Destructor.
	RtclCmdBase (const RtclCmdBase &)=delete
RtclCmdBase &	operator= (const RtclCmdBase &)=delete
int	DispatchCmd (RtclArgs &args)
	FIXME_docs.
void	AddMeth (const std::string &name, methfo_t &&methfo)
	FIXME_docs.
void	DelMeth (const std::string &name)
	FIXME_docs.
bool	TstMeth (const std::string &name)
	FIXME_docs.

Protected Member Functions
int	M_open (RtclArgs &args)
	FIXME_docs.
int	M_close (RtclArgs &args)
	FIXME_docs.
int	M_errcnt (RtclArgs &args)
	FIXME_docs.
int	M_rawread (RtclArgs &args)
	FIXME_docs.
int	M_rawrblk (RtclArgs &args)
	FIXME_docs.
int	M_rawwblk (RtclArgs &args)
	FIXME_docs.
int	M_stats (RtclArgs &args)
	FIXME_docs.
int	M_log (RtclArgs &args)
	FIXME_docs.
int	M_dump (RtclArgs &args)
	FIXME_docs.
int	M_get (RtclArgs &args)
	FIXME_docs.
int	M_set (RtclArgs &args)
	FIXME_docs.
int	M_default (RtclArgs &args)
	FIXME_docs.
void	SetupGetSet ()
	FIXME_docs.
bool	TestPort (RtclArgs &args, bool testopen=true)
	FIXME_docs.
void	SetLogFileName (const std::string &name)
	FIXME_docs.
const std::string &	LogFileName () const
	FIXME_docs.
Protected Member Functions inherited from Retro::RtclProxyBase
void	SetType (const std::string &type)
	FIXME_docs.
void	CreateObjectCmd (Tcl_Interp *interp, const char *name)
	FIXME_docs.
int	TclObjectCmd (Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
	FIXME_docs.
Protected Member Functions inherited from Retro::RtclCmdBase
bool	GetArgsDump (RtclArgs &args, int &detail)
	FIXME_docs.
int	M_info (RtclArgs &args)
	FIXME_docs.

Static Protected Member Functions
static int	DoRawRead (RtclArgs &args, RlinkPort &port)
	FIXME_docs.
static int	DoRawRblk (RtclArgs &args, RlinkPort &port, size_t &errcnt)
	FIXME_docs.
static int	DoRawWblk (RtclArgs &args, RlinkPort &port)
	FIXME_docs.
Static Protected Member Functions inherited from Retro::RtclProxyBase
static int	ThunkTclObjectCmd (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
	FIXME_docs.
static void	ThunkTclCmdDeleteProc (ClientData cdata)
	FIXME_docs.
static void	ThunkTclExitProc (ClientData cdata)
	FIXME_docs.

Protected Attributes
RlinkPort::port_uptr_t	fupObj
	uptr to managed port
std::shared_ptr< RlogFile >	fspLog
	port log file
uint32_t	fTraceLevel
	0=off,1=buf,2=char
size_t	fErrCnt
	error count
RtclGetList	fGets
RtclSetList	fSets
Protected Attributes inherited from Retro::RtclProxyBase
std::string	fType
	proxied type name
Tcl_Interp *	fInterp
	tcl interpreter
Tcl_Command	fCmdToken
	cmd token for object command
Protected Attributes inherited from Retro::RtclCmdBase
mmap_t	fMethMap
	map for named methods

Friends
class	RtclRlinkConnect

Additional Inherited Members
Public Types inherited from Retro::RtclCmdBase
typedef std::function< int(RtclArgs &)>	methfo_t
typedef std::map< std::string, methfo_t >	mmap_t
typedef mmap_t::iterator	mmap_it_t
typedef mmap_t::const_iterator	mmap_cit_t
Static Public Attributes inherited from Retro::RtclCmdBase
static const int	kOK = TCL_OK
static const int	kERR = TCL_ERROR

Detailed Description

FIXME_docs.

Definition at line 37 of file RtclRlinkPort.hpp.

Constructor & Destructor Documentation

RtclRlinkPort()

Retro::RtclRlinkPort::RtclRlinkPort	(	Tcl_Interp *	interp,
		const char *	name
	)

Default constructor.

Definition at line 59 of file RtclRlinkPort.cpp.

References Retro::RtclCmdBase::AddMeth(), Retro::RtclProxyBase::CreateObjectCmd(), M_close(), M_default(), M_dump(), M_errcnt(), M_get(), M_log(), M_open(), M_rawrblk(), M_rawread(), M_rawwblk(), M_set(), M_stats(), and SetupGetSet().

~RtclRlinkPort()

Retro::RtclRlinkPort::~RtclRlinkPort

(

)

Destructor.

Definition at line 88 of file RtclRlinkPort.cpp.

Member Function Documentation

M_open()

int Retro::RtclRlinkPort::M_open ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 94 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), fspLog, fTraceLevel, fupObj, Retro::RtclArgs::GetArg(), Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RtclArgs::NOptMiss(), Retro::RlinkPortFactory::Open(), Retro::RtclArgs::Quit(), Retro::RtclArgs::SetResult(), and SetupGetSet().

Referenced by RtclRlinkPort().

M_close()

int Retro::RtclRlinkPort::M_close ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 118 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), fupObj, Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, SetupGetSet(), and TestPort().

Referenced by RtclRlinkPort().

M_errcnt()

int Retro::RtclRlinkPort::M_errcnt ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 130 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), fErrCnt, Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RtclArgs::NextOpt(), and Retro::RtclArgs::SetResult().

Referenced by RtclRlinkPort().

M_rawread()

int Retro::RtclRlinkPort::M_rawread ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 150 of file RtclRlinkPort.cpp.

References DoRawRead(), fupObj, Retro::RtclCmdBase::kERR, and TestPort().

Referenced by RtclRlinkPort().

M_rawrblk()

int Retro::RtclRlinkPort::M_rawrblk ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 159 of file RtclRlinkPort.cpp.

References DoRawRblk(), fErrCnt, fupObj, Retro::RtclCmdBase::kERR, and TestPort().

Referenced by RtclRlinkPort().

M_rawwblk()

int Retro::RtclRlinkPort::M_rawwblk ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 168 of file RtclRlinkPort.cpp.

References DoRawWblk(), fupObj, Retro::RtclCmdBase::kERR, and TestPort().

Referenced by RtclRlinkPort().

M_stats()

int Retro::RtclRlinkPort::M_stats ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 177 of file RtclRlinkPort.cpp.

References Retro::RtclStats::Exec(), fupObj, Retro::RtclStats::GetArgs(), Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, and TestPort().

Referenced by RtclRlinkPort().

M_log()

int Retro::RtclRlinkPort::M_log ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 190 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), fspLog, fTraceLevel, Retro::RtclArgs::GetArg(), Retro::RtclCmdBase::kERR, and Retro::RtclCmdBase::kOK.

Referenced by RtclRlinkPort().

M_dump()

int Retro::RtclRlinkPort::M_dump ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 202 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), fupObj, Retro::RtclCmdBase::GetArgsDump(), Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RtclArgs::SetResult(), and TestPort().

Referenced by RtclRlinkPort().

M_get()

int Retro::RtclRlinkPort::M_get ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 218 of file RtclRlinkPort.cpp.

References fGets, and Retro::RtclGetList::M_get().

Referenced by RtclRlinkPort().

M_set()

int Retro::RtclRlinkPort::M_set ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 226 of file RtclRlinkPort.cpp.

References fSets, and Retro::RtclSetList::M_set().

Referenced by RtclRlinkPort().

M_default()

int Retro::RtclRlinkPort::M_default ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 234 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AllDone(), Retro::RtclArgs::AppendResultLines(), fspLog, fTraceLevel, Retro::RtclCmdBase::kERR, and Retro::RtclCmdBase::kOK.

Referenced by RtclRlinkPort().

SetupGetSet()

void Retro::RtclRlinkPort::SetupGetSet ( )

protected

FIXME_docs.

Definition at line 249 of file RtclRlinkPort.cpp.

References Retro::RtclGetList::Add(), Retro::RtclSetList::Add(), Retro::RtclGetList::Clear(), Retro::RtclSetList::Clear(), fGets, fSets, fupObj, LogFileName(), SetLogFileName(), Retro::RlinkPort::SetTraceLevel(), and Retro::RlinkPort::TraceLevel().

Referenced by M_close(), M_open(), and RtclRlinkPort().

TestPort()

bool Retro::RtclRlinkPort::TestPort ( RtclArgs &  args, bool  testopen = true  )

protected

FIXME_docs.

Definition at line 269 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::AppendResult(), and fupObj.

Referenced by M_close(), M_dump(), M_rawrblk(), M_rawread(), M_rawwblk(), and M_stats().

SetLogFileName()

void Retro::RtclRlinkPort::SetLogFileName ( const std::string &  name )

protected

FIXME_docs.

Definition at line 279 of file RtclRlinkPort.cpp.

References fspLog, and Retro::RerrMsg::Text().

Referenced by SetupGetSet().

LogFileName()

const std::string & Retro::RtclRlinkPort::LogFileName ( ) const

protected

FIXME_docs.

Definition at line 293 of file RtclRlinkPort.cpp.

References fspLog.

Referenced by SetupGetSet().

DoRawRead()

int Retro::RtclRlinkPort::DoRawRead ( RtclArgs &  args, RlinkPort &  port  )

staticprotected

FIXME_docs.

Definition at line 301 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::GetArg(), Retro::RtclArgs::Interp(), Retro::RlinkPort::kEof, Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RlinkPort::kTout, Retro::Rtcl::NewListIntObj(), Retro::RtclArgs::NextOpt(), Retro::RtclArgs::OptValid(), Retro::RtclArgs::Quit(), Retro::RlinkPort::RawRead(), Retro::RtclArgs::SetResult(), and Retro::Rtcl::SetVar().

Referenced by Retro::RtclRlinkConnect::M_rawread(), and M_rawread().

DoRawRblk()

int Retro::RtclRlinkPort::DoRawRblk ( RtclArgs &  args, RlinkPort &  port, size_t &  errcnt  )

staticprotected

FIXME_docs.

Definition at line 344 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::GetArg(), Retro::RtclArgs::Interp(), Retro::RlinkPort::kEof, Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RlinkPort::kTout, Retro::Rtcl::NewListIntObj(), Retro::RtclArgs::NextOpt(), Retro::RtclArgs::OptValid(), Retro::RtclArgs::Quit(), Retro::RlinkPort::RawRead(), Retro::RtclArgs::SetResult(), and Retro::Rtcl::SetVar().

Referenced by Retro::RtclRlinkConnect::M_rawrblk(), and M_rawrblk().

DoRawWblk()

int Retro::RtclRlinkPort::DoRawWblk ( RtclArgs &  args, RlinkPort &  port  )

staticprotected

FIXME_docs.

Definition at line 400 of file RtclRlinkPort.cpp.

References Retro::RtclArgs::GetArg(), Retro::RtclCmdBase::kERR, Retro::RtclCmdBase::kOK, Retro::RtclArgs::Quit(), and Retro::RlinkPort::RawWrite().

Referenced by Retro::RtclRlinkConnect::M_rawwblk(), and M_rawwblk().

Friends And Related Function Documentation

RtclRlinkConnect

friend class RtclRlinkConnect

friend

Definition at line 42 of file RtclRlinkPort.hpp.

Member Data Documentation

fupObj

RlinkPort::port_uptr_t Retro::RtclRlinkPort::fupObj

protected

uptr to managed port

Definition at line 68 of file RtclRlinkPort.hpp.

Referenced by M_close(), M_dump(), M_open(), M_rawrblk(), M_rawread(), M_rawwblk(), M_stats(), SetupGetSet(), and TestPort().

fspLog

std::shared_ptr<RlogFile> Retro::RtclRlinkPort::fspLog

protected

port log file

Definition at line 69 of file RtclRlinkPort.hpp.

Referenced by LogFileName(), M_default(), M_log(), M_open(), and SetLogFileName().

fTraceLevel

uint32_t Retro::RtclRlinkPort::fTraceLevel

protected

0=off,1=buf,2=char

Definition at line 70 of file RtclRlinkPort.hpp.

Referenced by M_default(), M_log(), and M_open().

fErrCnt

size_t Retro::RtclRlinkPort::fErrCnt

protected

error count

Definition at line 71 of file RtclRlinkPort.hpp.

Referenced by M_errcnt(), and M_rawrblk().

fGets

RtclGetList Retro::RtclRlinkPort::fGets

protected

Definition at line 72 of file RtclRlinkPort.hpp.

Referenced by M_get(), and SetupGetSet().

fSets

RtclSetList Retro::RtclRlinkPort::fSets

protected

Definition at line 73 of file RtclRlinkPort.hpp.

Referenced by M_set(), and SetupGetSet().

---

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

• librlinktpp/RtclRlinkPort.hpp
• librlinktpp/RtclRlinkPort.cpp