Retro::RtclRlinkConnect Class Reference

FIXME_docs. More...

#include <RtclRlinkConnect.hpp>

Inheritance diagram for Retro::RtclRlinkConnect:

Collaboration diagram for Retro::RtclRlinkConnect:

Public Member Functions
	RtclRlinkConnect (Tcl_Interp *interp, const char *name)
	Default constructor.
	~RtclRlinkConnect ()
	Destructor.
Public Member Functions inherited from Retro::RtclProxyOwned< RlinkConnect >
	RtclProxyOwned ()
	Default constructor.
	RtclProxyOwned (const std::string &type)
	FIXME_docs.
	RtclProxyOwned (const std::string &type, Tcl_Interp *interp, const char *name, RlinkConnect *pobj=nullptr)
	FIXME_docs.
	~RtclProxyOwned ()
	FIXME_docs.
RlinkConnect &	Obj ()
	FIXME_docs.
const std::shared_ptr< RlinkConnect > &	ObjSPtr ()
	FIXME_docs.
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_init (RtclArgs &args)
	FIXME_docs.
int	M_exec (RtclArgs &args)
	FIXME_docs.
int	M_amap (RtclArgs &args)
	FIXME_docs.
int	M_errcnt (RtclArgs &args)
	FIXME_docs.
int	M_wtlam (RtclArgs &args)
	FIXME_docs.
int	M_oob (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_print (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.
bool	GetAddr (RtclArgs &args, uint16_t &addr)
	FIXME_docs.
bool	GetVarName (RtclArgs &args, const char *argname, size_t nind, std::vector< std::string > &varname)
	FIXME_docs.
bool	ConfigBase (RtclArgs &args, uint32_t &base)
	FIXME_docs.
bool	ClistNonEmpty (RtclArgs &args, const RlinkCommandList &clist)
	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.

Protected Attributes
RtclOPtr	fCmdnameObj [8]
RtclGetList	fGets
RtclSetList	fSets
Protected Attributes inherited from Retro::RtclProxyOwned< RlinkConnect >
std::shared_ptr< RlinkConnect >	fspObj
	sptr to managed object
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

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
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.

Detailed Description

FIXME_docs.

Definition at line 36 of file RtclRlinkConnect.hpp.

Constructor & Destructor Documentation

RtclRlinkConnect()

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

Default constructor.

Definition at line 82 of file RtclRlinkConnect.cpp.

References Retro::RtclGetList::Add(), Retro::RtclSetList::Add(), Retro::RtclCmdBase::AddMeth(), Retro::RlinkConnect::BlockSizeMax(), Retro::RlinkConnect::BlockSizePrudent(), Retro::RlinkCommand::CommandName(), Retro::RlinkConnect::Context(), Retro::RlinkConnect::DumpLevel(), fCmdnameObj, fGets, fSets, Retro::RlinkConnect::HasRbmon(), Retro::RlinkConnect::LinkInitDone(), Retro::RlinkConnect::LogBaseAddr(), Retro::RlinkConnect::LogBaseData(), Retro::RlinkConnect::LogBaseStat(), Retro::RlinkConnect::LogFileName(), M_amap(), M_close(), M_default(), M_dump(), M_errcnt(), M_exec(), M_get(), M_init(), M_log(), M_oob(), M_open(), M_print(), M_rawrblk(), M_rawread(), M_rawwblk(), M_set(), M_stats(), M_wtlam(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RlinkConnect::PrintLevel(), Retro::RlinkConnect::RbufSize(), Retro::RlinkConnect::SetDumpLevel(), Retro::RlinkConnect::SetLogBaseAddr(), Retro::RlinkConnect::SetLogBaseData(), Retro::RlinkConnect::SetLogBaseStat(), Retro::RlinkConnect::SetLogFileName(), Retro::RlinkConnect::SetPrintLevel(), Retro::RlinkContext::SetStatusMask(), Retro::RlinkContext::SetStatusValue(), Retro::RlinkConnect::SetTimeout(), Retro::RlinkConnect::SetTraceLevel(), Retro::RlinkContext::StatusIsChecked(), Retro::RlinkContext::StatusMask(), Retro::RlinkContext::StatusValue(), Retro::RlinkConnect::SysId(), Retro::RlinkConnect::Timeout(), Retro::RlinkConnect::TraceLevel(), and Retro::RlinkConnect::UsrAcc().

~RtclRlinkConnect()

Retro::RtclRlinkConnect::~RtclRlinkConnect

(

)

Destructor.

Definition at line 167 of file RtclRlinkConnect.cpp.

Member Function Documentation

M_open()

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

protected

FIXME_docs.

Definition at line 173 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RtclArgs::GetArg(), Retro::RlinkConnect::IsOpen(), Retro::kERR, Retro::kOK, Retro::RtclArgs::NOptMiss(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RlinkConnect::Port(), Retro::RtclArgs::Quit(), Retro::RtclArgs::SetResult(), Retro::RlinkPort::Url(), and Retro::RparseUrl::Url().

Referenced by RtclRlinkConnect().

M_close()

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

protected

FIXME_docs.

Definition at line 193 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RlinkConnect::Close(), Retro::kERR, Retro::kOK, Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_init()

int Retro::RtclRlinkConnect::M_init ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 204 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::kERR, Retro::kOK, Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_exec()

int Retro::RtclRlinkConnect::M_exec ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 217 of file RtclRlinkConnect.cpp.

References Retro::RlinkCommandList::AddAttn(), Retro::RlinkCommandList::AddInit(), Retro::RlinkCommandList::AddLabo(), Retro::RlinkCommandList::AddRblk(), Retro::RlinkCommandList::AddRreg(), Retro::RlinkCommandList::AddWblk(), Retro::RlinkCommandList::AddWreg(), Retro::RtclArgs::AllDone(), Retro::RlinkCommand::Block(), Retro::RlinkCommand::BlockDone(), ClistNonEmpty(), Retro::RlinkCommand::Command(), Retro::RlinkCommand::Data(), Retro::RlinkCommandList::Dump(), fCmdnameObj, Retro::RlinkCommand::Flags(), GetAddr(), Retro::RtclArgs::GetArg(), GetVarName(), Retro::RtclArgs::Interp(), Retro::RlinkCommand::kCmdAttn, Retro::RlinkCommand::kCmdLabo, Retro::RlinkCommand::kCmdRblk, Retro::RlinkCommand::kCmdRreg, Retro::RlinkCommand::kCmdWblk, Retro::kERR, Retro::kOK, Retro::RlinkCommand::kStat_M_RbErr, Retro::RlinkCommand::kStat_M_RbNak, Retro::RlinkCommand::kStat_M_RbTout, Retro::Rtcl::NewLinesObj(), Retro::Rtcl::NewListIntObj(), Retro::RtclArgs::NextOpt(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RlinkCommandList::Print(), Retro::RtclArgs::Quit(), Retro::RlinkCommand::Request(), Retro::RlinkCommandList::SetLastExpectBlock(), Retro::RlinkCommandList::SetLastExpectData(), Retro::RlinkCommandList::SetLastExpectDone(), Retro::RlinkCommandList::SetLastExpectStatus(), Retro::Rtcl::SetVar(), Retro::Rtcl::SetVarOrResult(), Retro::RlinkCommandList::Size(), and Retro::RlinkCommand::Status().

Referenced by RtclRlinkConnect().

M_amap()

int Retro::RtclRlinkConnect::M_amap ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 439 of file RtclRlinkConnect.cpp.

References Retro::RlinkConnect::AddrMap(), Retro::RlinkConnect::AddrMapClear(), Retro::RlinkConnect::AddrMapInsert(), Retro::RtclArgs::AllDone(), Retro::RlinkAddrMap::Amap(), Retro::RtclArgs::AppendResultLines(), Retro::RlinkAddrMap::Find(), Retro::RtclArgs::GetArg(), Retro::kERR, Retro::kOK, Retro::RtclArgs::NDone(), Retro::RtclArgs::NextOpt(), Retro::RtclArgs::NOptMiss(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RtclArgs::OptValid(), Retro::RtclArgs::PeekArgString(), Retro::RlinkAddrMap::Print(), Retro::RtclArgs::Quit(), and Retro::RtclArgs::SetResult().

Referenced by RtclRlinkConnect().

M_errcnt()

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

protected

FIXME_docs.

Definition at line 544 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RlinkContext::ClearErrorCount(), Retro::RlinkConnect::Context(), Retro::RlinkContext::IncErrorCount(), Retro::kERR, Retro::kOK, Retro::RtclArgs::NextOpt(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::SetResult().

Referenced by RtclRlinkConnect().

M_wtlam()

int Retro::RtclRlinkConnect::M_wtlam ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 567 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RlinkConnect::Context(), Retro::RtclArgs::GetArg(), Retro::RlinkContext::IncErrorCount(), Retro::RtclArgs::Interp(), Retro::kERR, Retro::kOK, Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RtclArgs::Quit(), Retro::RosPrintf(), Retro::RtclArgs::SetResult(), Retro::Rtcl::SetVar(), and Retro::RlinkConnect::WaitAttn().

Referenced by RtclRlinkConnect().

M_oob()

int Retro::RtclRlinkConnect::M_oob ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 618 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RtclArgs::GetArg(), Retro::kERR, Retro::kOK, Retro::RlinkConnect::kSBCNTL_V_RBMON, Retro::RlinkConnect::kSBCNTL_V_RLBMON, Retro::RlinkConnect::kSBCNTL_V_RLMON, Retro::RtclArgs::NextOpt(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_rawread()

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

protected

FIXME_docs.

Definition at line 669 of file RtclRlinkConnect.cpp.

References Retro::RtclRlinkPort::DoRawRead(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_rawrblk()

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

protected

FIXME_docs.

Definition at line 679 of file RtclRlinkConnect.cpp.

References Retro::RlinkConnect::Context(), Retro::RtclRlinkPort::DoRawRblk(), Retro::RlinkContext::IncErrorCount(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_rawwblk()

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

protected

FIXME_docs.

Definition at line 692 of file RtclRlinkConnect.cpp.

References Retro::RtclRlinkPort::DoRawWblk(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::Quit().

Referenced by RtclRlinkConnect().

M_stats()

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

protected

FIXME_docs.

Definition at line 702 of file RtclRlinkConnect.cpp.

References Retro::RtclStats::Exec(), Retro::RtclStats::GetArgs(), Retro::kERR, Retro::kOK, and Retro::RtclProxyOwned< RlinkConnect >::Obj().

Referenced by RtclRlinkConnect().

M_log()

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

protected

FIXME_docs.

Definition at line 718 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RtclArgs::GetArg(), Retro::kERR, Retro::kOK, Retro::RlinkConnect::LogFile(), Retro::RtclArgs::NextOpt(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RtclArgs::OptValid(), and Retro::RlogFile::Write().

Referenced by RtclRlinkConnect().

M_print()

int Retro::RtclRlinkConnect::M_print ( RtclArgs &  args )

protected

FIXME_docs.

Definition at line 751 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::kERR, Retro::kOK, Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RlinkConnect::Print(), and Retro::RtclArgs::SetResult().

Referenced by RtclRlinkConnect().

M_dump()

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

protected

FIXME_docs.

Definition at line 764 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RlinkConnect::Dump(), Retro::RtclCmdBase::GetArgsDump(), Retro::kERR, Retro::kOK, Retro::RtclProxyOwned< RlinkConnect >::Obj(), and Retro::RtclArgs::SetResult().

Referenced by RtclRlinkConnect().

M_get()

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

protected

FIXME_docs.

Definition at line 779 of file RtclRlinkConnect.cpp.

References fGets, Retro::RtclGetList::M_get(), and Retro::RtclProxyOwned< RlinkConnect >::Obj().

Referenced by RtclRlinkConnect().

M_set()

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

protected

FIXME_docs.

Definition at line 789 of file RtclRlinkConnect.cpp.

References fSets, Retro::RtclSetList::M_set(), and Retro::RtclProxyOwned< RlinkConnect >::Obj().

Referenced by RtclRlinkConnect().

M_default()

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

protected

FIXME_docs.

Definition at line 799 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AllDone(), Retro::RtclArgs::AppendResultLines(), Retro::RlinkConnect::DumpLevel(), Retro::kERR, Retro::kOK, Retro::RlinkConnect::LogFile(), Retro::RlogFile::Name(), Retro::RtclProxyOwned< RlinkConnect >::Obj(), Retro::RlinkConnect::PrintLevel(), and Retro::RosPrintf().

Referenced by RtclRlinkConnect().

GetAddr()

bool Retro::RtclRlinkConnect::GetAddr ( RtclArgs &  args, uint16_t &  addr  )

protected

FIXME_docs.

Definition at line 818 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AppendResult(), Retro::RtclArgs::GetArg(), Retro::kERR, Retro::kOK, and Retro::RtclProxyOwned< RlinkConnect >::Obj().

Referenced by M_exec().

GetVarName()

bool Retro::RtclRlinkConnect::GetVarName ( RtclArgs &  args, const char *  argname, size_t  nind, std::vector< std::string > &  varname  )

protected

FIXME_docs.

Definition at line 852 of file RtclRlinkConnect.cpp.

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

Referenced by M_exec().

ConfigBase()

bool Retro::RtclRlinkConnect::ConfigBase ( RtclArgs &  args, uint32_t &  base  )

protected

FIXME_docs.

Definition at line 875 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AppendResult(), Retro::RtclArgs::Config(), and Retro::RtclArgs::PeekArgString().

ClistNonEmpty()

bool Retro::RtclRlinkConnect::ClistNonEmpty ( RtclArgs &  args, const RlinkCommandList &  clist  )

protected

FIXME_docs.

Definition at line 891 of file RtclRlinkConnect.cpp.

References Retro::RtclArgs::AppendResult(), and Retro::RlinkCommandList::Size().

Referenced by M_exec().

Member Data Documentation

fCmdnameObj

RtclOPtr Retro::RtclRlinkConnect::fCmdnameObj[8]

protected

Definition at line 69 of file RtclRlinkConnect.hpp.

Referenced by M_exec(), and RtclRlinkConnect().

fGets

RtclGetList Retro::RtclRlinkConnect::fGets

protected

Definition at line 70 of file RtclRlinkConnect.hpp.

Referenced by M_get(), and RtclRlinkConnect().

fSets

RtclSetList Retro::RtclRlinkConnect::fSets

protected

Definition at line 71 of file RtclRlinkConnect.hpp.

Referenced by M_set(), and RtclRlinkConnect().

---

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

• librlinktpp/RtclRlinkConnect.hpp
• librlinktpp/RtclRlinkConnect.cpp