nsukit 命名空间参考

类
class	BaseKit
struct	CommandPack
class	I_BaseCmdUItf
class	I_BaseRegMw
class	I_BaseStreamMw
class	I_BaseStreamUItf
class	ICDRegMw
class	JsonWrapper
class	Mixin_NativeRegCmd
class	Mixin_VirtualRegCmd
class	NSUSoc
class	PCIECmdUItf
class	PCIERingUItf
class	PCIEStreamUItf
class	RegOperationMixin
class	SerialCmdUItf
class	SerialStreamUItf
class	SimCmdUItf
class	SimStreamUItf
class	SocketGenerator
struct	StandardCmdFeedback
class	TCPCmdUItf
class	TCPStreamUItf
class	U_BaseCmdMixin
class	U_Interface
class	U_Middleware
class	VirtualChnlMw
class	XDMAOperation_t

函数
template<>
std::string	JsonWrapper::get_icd_param< std::string > (nsuCSParam_t &param_name)
int	TcpRecvBytes (SocketGenerator *s, char *buf, size_t len, bool *stopped=nullptr)
int	TcpSendBytes (SocketGenerator *s, char *buf, size_t len, bool *stopped=nullptr)
std::string NSU_DLLEXPORT	api_info ()
std::string NSU_DLLEXPORT	status2_string (nsukitStatus_t status)
DLLEXTERN void NSU_DLLEXPORT *	hl_fc_create_soc (uint8_t type=0)
DLLEXTERN void NSU_DLLEXPORT	hl_fc_release_soc (nsukit::BaseKit *kit)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_link_cmd (nsukit::BaseKit *kit, const char *addr, uint32_t port, const char *icd_path)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_unlink_cmd (nsukit::BaseKit *kit)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_link_stream (nsukit::BaseKit *kit, uint32_t port)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_unlink_stream (nsukit::BaseKit *kit)
template<typename T >
nsukitStatus_t	hl_fc_set_param (nsukit::BaseKit *kit, const char *name, T value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_parami32 (nsukit::BaseKit *kit, const char *name, int32_t value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_parami16 (nsukit::BaseKit *kit, const char *name, int16_t value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_parami8 (nsukit::BaseKit *kit, const char *name, int8_t value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_paramf32 (nsukit::BaseKit *kit, const char *name, float value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_paramf64 (nsukit::BaseKit *kit, const char *name, double value)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_set_paramstr (nsukit::BaseKit *kit, const char *name, void *value)
template<typename T >
T	hl_fc_get_param (nsukit::BaseKit *kit, const char *name)
DLLEXTERN int32_t NSU_DLLEXPORT	hl_fc_get_parami32 (nsukit::BaseKit *kit, const char *name)
DLLEXTERN int16_t NSU_DLLEXPORT	hl_fc_get_parami16 (nsukit::BaseKit *kit, const char *name)
DLLEXTERN int8_t NSU_DLLEXPORT	hl_fc_get_parami8 (nsukit::BaseKit *kit, const char *name)
DLLEXTERN float NSU_DLLEXPORT	hl_fc_get_paramf32 (nsukit::BaseKit *kit, const char *name)
DLLEXTERN double NSU_DLLEXPORT	hl_fc_get_paramf64 (nsukit::BaseKit *kit, const char *name)
DLLEXTERN char NSU_DLLEXPORT *	hl_fc_get_paramstr (nsukit::BaseKit *kit, const char *name)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_execute (nsukit::BaseKit *kit, const char *name)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_write (nsukit::BaseKit *kit, nsuRegAddr_t name, nsuRegValue_t value)
DLLEXTERN nsuRegValue_t NSU_DLLEXPORT	hl_fc_read (nsukit::BaseKit *kit, nsuRegAddr_t name)
DLLEXTERN nsuMemory_p NSU_DLLEXPORT	hl_fc_alloc_buffer (nsukit::BaseKit *kit, nsuStreamLen_t length, nsuVoidBuf_p buf=nullptr)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_free_buffer (nsukit::BaseKit *kit, nsuMemory_p fd)
DLLEXTERN nsuVoidBuf_p NSU_DLLEXPORT	hl_fc_get_buffer (nsukit::BaseKit *kit, nsuMemory_p fd, nsuStreamLen_t length=0)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_stream_recv (nsukit::BaseKit *kit, nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_wait_stream (nsukit::BaseKit *kit, nsuMemory_p fd, float timeout=0.)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_break_stream (nsukit::BaseKit *kit, nsuMemory_p fd)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_open_recv (nsukit::BaseKit *kit, nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, nsuStreamLen_t offset=0)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_fc_recv_to_file_useless (nsukit::BaseKit *kit, nsuChnlNum_t chnl, nsuMemory_p fd, nsuStreamLen_t length, const char *file_name)
DLLEXTERN uint32_t NSU_DLLEXPORT	hl_fc_tool_get_first_point (nsuVoidBuf_p data_p)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_hsync_sync (nsukit::BaseKit *master, nsukit::BaseKit **slaves, int slave_num, char *cmd_str=nullptr)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_sawg_init (nsukit::BaseKit *kit)
DLLEXTERN nsukitStatus_t NSU_DLLEXPORT	hl_sawg_send_wave (nsukit::BaseKit *kit, nsuRegAddr_t addr, nsuStreamLen_t length)
NSU_DLLEXPORT void	DeleteCommandPack (CommandPack *pack)
NSU_DLLEXPORT uint32_t	GetFileSize (const std::string &file_path)
NSU_DLLEXPORT bool	StringEndWith (const std::string &str, const std::string &tail)
NSU_DLLEXPORT bool	StringStartWith (const std::string &str, const std::string &head)

变量
static std::map< std::string, int >	TypeSizeMap

详细描述

待办事项:

SuperAWG封装待实现

函数说明

api_info()

std::string nsukit::api_info

(

)

在文件 config.cpp 第 8 行定义.

DeleteCommandPack()

void nsukit::DeleteCommandPack

(

CommandPack *

pack

)

删除通过new申请的CommandPack

参数

pack	在堆上的CommandPack的指针

在文件 icd_parser.cpp 第 488 行定义.

GetFileSize()

uint32_t nsukit::GetFileSize

(

const std::string &

file_path

)

在文件 icd_parser.cpp 第 455 行定义.

hl_fc_alloc_buffer()

nsuMemory_p nsukit::hl_fc_alloc_buffer	(	nsukit::BaseKit *	kit,
		nsuStreamLen_t	length,
		nsuVoidBuf_p	buf = nullptr
	)

在文件 FunctionCall.cpp 第 131 行定义.

hl_fc_break_stream()

nsukitStatus_t nsukit::hl_fc_break_stream	(	nsukit::BaseKit *	kit,
		nsuMemory_p	fd
	)

在文件 FunctionCall.cpp 第 152 行定义.

hl_fc_create_soc()

void * nsukit::hl_fc_create_soc

(

uint8_t

type = 0

)

在文件 FunctionCall.cpp 第 21 行定义.

hl_fc_execute()

nsukitStatus_t nsukit::hl_fc_execute	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 117 行定义.

hl_fc_free_buffer()

nsukitStatus_t nsukit::hl_fc_free_buffer	(	nsukit::BaseKit *	kit,
		nsuMemory_p	fd
	)

在文件 FunctionCall.cpp 第 135 行定义.

hl_fc_get_buffer()

nsuVoidBuf_p nsukit::hl_fc_get_buffer	(	nsukit::BaseKit *	kit,
		nsuMemory_p	fd,
		nsuStreamLen_t	length = 0
	)

在文件 FunctionCall.cpp 第 139 行定义.

hl_fc_get_param()

template<typename T >

T nsukit::hl_fc_get_param	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.h 第 68 行定义.

hl_fc_get_paramf32()

float nsukit::hl_fc_get_paramf32	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 100 行定义.

hl_fc_get_paramf64()

double nsukit::hl_fc_get_paramf64	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 104 行定义.

hl_fc_get_parami16()

int16_t nsukit::hl_fc_get_parami16	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 92 行定义.

hl_fc_get_parami32()

int32_t nsukit::hl_fc_get_parami32	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 88 行定义.

hl_fc_get_parami8()

int8_t nsukit::hl_fc_get_parami8	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 96 行定义.

hl_fc_get_paramstr()

char * nsukit::hl_fc_get_paramstr	(	nsukit::BaseKit *	kit,
		const char *	name
	)

在文件 FunctionCall.cpp 第 108 行定义.

hl_fc_link_cmd()

nsukitStatus_t nsukit::hl_fc_link_cmd	(	nsukit::BaseKit *	kit,
		const char *	addr,
		uint32_t	port,
		const char *	icd_path
	)

在文件 FunctionCall.cpp 第 37 行定义.

hl_fc_link_stream()

nsukitStatus_t nsukit::hl_fc_link_stream	(	nsukit::BaseKit *	kit,
		uint32_t	port
	)

在文件 FunctionCall.cpp 第 50 行定义.

hl_fc_open_recv()

nsukitStatus_t nsukit::hl_fc_open_recv	(	nsukit::BaseKit *	kit,
		nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = 0
	)

在文件 FunctionCall.cpp 第 156 行定义.

hl_fc_read()

DLLEXTERN nsuRegValue_t NSU_DLLEXPORT nsukit::hl_fc_read	(	nsukit::BaseKit *	kit,
		nsuRegAddr_t	name
	)

在文件 FunctionCall.cpp 第 125 行定义.

hl_fc_recv_to_file_useless()

nsukitStatus_t nsukit::hl_fc_recv_to_file_useless	(	nsukit::BaseKit *	kit,
		nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		const char *	file_name
	)

在文件 FunctionCall.cpp 第 161 行定义.

hl_fc_release_soc()

void nsukit::hl_fc_release_soc

(

nsukit::BaseKit *

kit

)

在文件 FunctionCall.cpp 第 30 行定义.

hl_fc_set_param()

template<typename T >

nsukitStatus_t nsukit::hl_fc_set_param	(	nsukit::BaseKit *	kit,
		const char *	name,
		T	value
	)

在文件 FunctionCall.h 第 43 行定义.

hl_fc_set_paramf32()

nsukitStatus_t nsukit::hl_fc_set_paramf32	(	nsukit::BaseKit *	kit,
		const char *	name,
		float	value
	)

在文件 FunctionCall.cpp 第 72 行定义.

hl_fc_set_paramf64()

nsukitStatus_t nsukit::hl_fc_set_paramf64	(	nsukit::BaseKit *	kit,
		const char *	name,
		double	value
	)

在文件 FunctionCall.cpp 第 76 行定义.

hl_fc_set_parami16()

nsukitStatus_t nsukit::hl_fc_set_parami16	(	nsukit::BaseKit *	kit,
		const char *	name,
		int16_t	value
	)

在文件 FunctionCall.cpp 第 64 行定义.

hl_fc_set_parami32()

nsukitStatus_t nsukit::hl_fc_set_parami32	(	nsukit::BaseKit *	kit,
		const char *	name,
		int32_t	value
	)

在文件 FunctionCall.cpp 第 60 行定义.

hl_fc_set_parami8()

nsukitStatus_t nsukit::hl_fc_set_parami8	(	nsukit::BaseKit *	kit,
		const char *	name,
		int8_t	value
	)

在文件 FunctionCall.cpp 第 68 行定义.

hl_fc_set_paramstr()

nsukitStatus_t nsukit::hl_fc_set_paramstr	(	nsukit::BaseKit *	kit,
		const char *	name,
		void *	value
	)

在文件 FunctionCall.cpp 第 80 行定义.

hl_fc_stream_recv()

nsukitStatus_t nsukit::hl_fc_stream_recv	(	nsukit::BaseKit *	kit,
		nsuChnlNum_t	chnl,
		nsuMemory_p	fd,
		nsuStreamLen_t	length,
		nsuStreamLen_t	offset = 0
	)

在文件 FunctionCall.cpp 第 143 行定义.

hl_fc_tool_get_first_point()

uint32_t nsukit::hl_fc_tool_get_first_point

(

nsuVoidBuf_p

data_p

)

在文件 FunctionCall.cpp 第 167 行定义.

hl_fc_unlink_cmd()

nsukitStatus_t nsukit::hl_fc_unlink_cmd

(

nsukit::BaseKit *

kit

)

在文件 FunctionCall.cpp 第 46 行定义.

hl_fc_unlink_stream()

nsukitStatus_t nsukit::hl_fc_unlink_stream

(

nsukit::BaseKit *

kit

)

在文件 FunctionCall.cpp 第 56 行定义.

hl_fc_wait_stream()

nsukitStatus_t nsukit::hl_fc_wait_stream	(	nsukit::BaseKit *	kit,
		nsuMemory_p	fd,
		float	timeout = 0.
	)

在文件 FunctionCall.cpp 第 148 行定义.

hl_fc_write()

nsukitStatus_t nsukit::hl_fc_write	(	nsukit::BaseKit *	kit,
		nsuRegAddr_t	name,
		nsuRegValue_t	value
	)

在文件 FunctionCall.cpp 第 121 行定义.

hl_hsync_sync()

nsukitStatus_t nsukit::hl_hsync_sync	(	nsukit::BaseKit *	master,
		nsukit::BaseKit **	slaves,
		int	slave_num,
		char *	cmd_str = nullptr
	)

参数

master	主soc
slaves	从soc列表
slave_num	从soc的数量
cmd_str	可选参数 同步流程要配置的六个指令名称，默认值为宏定义HSYNC_DEFAULT_CMD_FMT，分隔符为宏定义HSYNC_CMD_FMT_DELIM 当只配置了一条指令时，则会对master与slaves执行同样的指令，对应所有soc独立同步的情况

返回

函数运行结果

返回值

nsukitStatus_t::NSUKIT_STATUS_SUCCESS	同步成功
nsukitStatus_t::NSUKIT_STATUS_INVALID_VALUE	cmd_str参数不符合规则

#include "NSUKit.h"
void main() {
    nsukit::Basekit * slaves[5];   // 5个slave soc
    nsukit::NSUSoc<nsukit::TCPCmdUItf, nsukit::PCIECmdUItf, nsukit::PCIEStreamUItf> kit{};  // master soc
    nsuInitParam_t param;
    param.cmd_ip = "xxx.xxx.xxx.xxx";
    param.cmd_board = 0;
    param.stream_board = 0;
    kit.link_cmd(&param);
 
    auto res = hl_hsync_sync(kit, slaves, 5);
}

在文件 HardwareSync.cpp 第 76 行定义.

hl_sawg_init()

nsukitStatus_t nsukit::hl_sawg_init

(

nsukit::BaseKit *

kit

)

警告

未实现

参数

kit

返回

在文件 SuperAWG.cpp 第 11 行定义.

hl_sawg_send_wave()

DLLEXTERN nsukitStatus_t NSU_DLLEXPORT nsukit::hl_sawg_send_wave	(	nsukit::BaseKit *	kit,
		nsuRegAddr_t	addr,
		nsuStreamLen_t	length
	)

警告

未实现

参数

kit
addr
length

返回

JsonWrapper::get_icd_param< std::string >()

template<>

std::string nsukit::JsonWrapper::get_icd_param< std::string > ( nsuCSParam_t &  param_name )

inline

模板特化，针对file类型的参数，或者想以字符串形式表示的参数

参数

param_name

参数名称

返回

string

在文件 json_icd_wrapper.h 第 134 行定义.

status2_string()

std::string nsukit::status2_string

(

nsukitStatus_t

status

)

在文件 config.cpp 第 15 行定义.

StringEndWith()

bool nsukit::StringEndWith	(	const std::string &	str,
		const std::string &	tail
	)

判断一个字符串str是不是以tail结尾的

参数

str	目标字符串
tail	目标结尾

返回

bool 是或否

在文件 icd_parser.cpp 第 470 行定义.

StringStartWith()

bool nsukit::StringStartWith	(	const std::string &	str,
		const std::string &	head
	)

判断一个字符串str是不是以head开头的

参数

str	目标字符串
head	目标开头

返回

bool 是或否

在文件 icd_parser.cpp 第 480 行定义.

TcpRecvBytes()

int nsukit::TcpRecvBytes	(	SocketGenerator *	s,
		char *	buf,
		size_t	len,
		bool *	stopped = nullptr
	)

在文件 c_socket.cpp 第 203 行定义.

TcpSendBytes()

int nsukit::TcpSendBytes	(	SocketGenerator *	s,
		char *	buf,
		size_t	len,
		bool *	stopped = nullptr
	)

在文件 c_socket.cpp 第 228 行定义.

变量说明

TypeSizeMap

std::map<std::string, int> nsukit::TypeSizeMap

static

初始值:

= {
            {ICD_Uint8,      1},
            {ICD_Int8,       1},
            {ICD_Uint16,     2},
            {ICD_Int16,      2},
            {ICD_Uint32,     4},
            {ICD_Int32,      4},
            {ICD_Float,      4},
            {ICD_FileLength, 4},
            {ICD_Double,     8}
    }

在文件 icd_parser.h 第 29 行定义.