1. Introduction¶
1.1. 함수의 명명 규칙¶
ComiSWECAT 에서 제공하는 모든 함수는 다른 API 함수와 이름이 중복되는 것을 피하기 위하여 “sec”이라는 첨두어가 붙습니다.
“sec” 뒤에 해당 함수가 속하는 기능의 그룹을 대표하는 첨두어가 이어집니다.
1.1.1. 예시¶
General Functions (Gn) |
secGn_LoadDevices / secGn_GetNumDevices |
환경설정 함수들 (Cfg) |
secCfg_Start / secCfg_End |
슬레이브 인터페이스 함수들 (Slv) |
secSlv_GetProdInfo_A / secSlv_GetState_A |
1.2. 데이터형 표기¶
본 매뉴얼에서의 데이터 형 표기는 아래 표와 같습니다.
Data Type |
Description |
C/C++ |
---|---|---|
t_char |
1 바이트 ASCII 문자 코드 |
char |
t_byte |
부호가 없는 양의 정수 |
unsigned char |
t_uchar |
부호가 없는 양의 정수 |
unsigned char |
t_bool |
True 나 False 형태의 논리형 |
bool |
t_i8 |
1 바이트 ASCII 문자 코드 |
char |
t_ui8 |
부호가 없는 양의 정수 |
unsigned char |
t_i16 |
부호가 있는 2 바이트 정수 |
short |
t_word |
부호가 없는 2 바이트 정수 |
unsigned short |
t_ui16 |
부호가 없는 2 바이트 정수 |
unsigned short |
t_i32 |
부호가 있는 4 바이트 정수 |
int |
t_ui32 |
부호가 없는 4 바이트 정수 |
unsigned int |
t_dword |
부호가 없는 4 바이트 정수 |
unsigned int |
t_f32 |
부호가 있는 4 바이트 실수 |
float |
t_f64 |
부호가 있는 8 바이트 실수 |
double |
t_success |
True 나 False 형태의 논리형 |
bool |
t_cmdidx |
부호가 없는 4 바이트 정수 |
unsigned int |
1.3. 파라미터 In / Out 표기¶
본 매뉴얼에서는 “[in]”과 “[out]” 표기를 사용해 파라미터가 함수에 전달되는 것인지, 전달받는 것인지 명시하였습니다.
이 표기는 본 매뉴얼에서만 사용되는 것이며, 실제 헤더파일에는 표기되어 있지 않습니다.