ngc 1.5.0
 
Loading...
Searching...
No Matches
ngcb_cmd_handle_t Class Reference

#include <ngcbCMD.hpp>

Public Member Functions

 ngcb_cmd_handle_t ()
 Constructor.
 
virtual ~ngcb_cmd_handle_t ()
 Destructor.
 
int Id ()
 Return component id.
 
int Id (const char *filter)
 Format parameter string and return filtered component id.
 
int Param (const char *p, const char *filter=NULL)
 Assign parameter string.
 
char * Param ()
 Return parameter string.
 
int Get (const char *filter, char *s)
 Get filtered string parameter.
 
int Get (const char *filter, double *v)
 Get filtered double precision parameter.
 
int Get (const char *filter)
 Get filtered 32-bit signed integer parameter.
 
unsigned int GetX (const char *filter)
 Get filtered 32-bit unsigned integer parameter.
 

Public Attributes

int flags
 Forwarded flags (ngcbCMD_UPDATE, ngcbCMD_PROTECTED)
 
void * udata
 Forwarded user data.
 
int done
 Done flag.
 
int fd
 File descriptor of command source.
 

Detailed Description

Command handle class

Constructor & Destructor Documentation

◆ ngcb_cmd_handle_t()

ngcb_cmd_handle_t::ngcb_cmd_handle_t ( )
inline

Constructor.

◆ ~ngcb_cmd_handle_t()

virtual ngcb_cmd_handle_t::~ngcb_cmd_handle_t ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Get() [1/3]

int ngcb_cmd_handle_t::Get ( const char * filter)
inline

Get filtered 32-bit signed integer parameter.

◆ Get() [2/3]

int ngcb_cmd_handle_t::Get ( const char * filter,
char * s )
inline

Get filtered string parameter.

◆ Get() [3/3]

int ngcb_cmd_handle_t::Get ( const char * filter,
double * v )
inline

Get filtered double precision parameter.

◆ GetX()

unsigned int ngcb_cmd_handle_t::GetX ( const char * filter)
inline

Get filtered 32-bit unsigned integer parameter.

◆ Id() [1/2]

int ngcb_cmd_handle_t::Id ( )
inline

Return component id.

◆ Id() [2/2]

int ngcb_cmd_handle_t::Id ( const char * filter)
inline

Format parameter string and return filtered component id.

◆ Param() [1/2]

char * ngcb_cmd_handle_t::Param ( )
inline

Return parameter string.

◆ Param() [2/2]

int ngcb_cmd_handle_t::Param ( const char * p,
const char * filter = NULL )
inline

Assign parameter string.

Member Data Documentation

◆ done

int ngcb_cmd_handle_t::done

Done flag.

◆ fd

int ngcb_cmd_handle_t::fd

File descriptor of command source.

◆ flags

int ngcb_cmd_handle_t::flags

Forwarded flags (ngcbCMD_UPDATE, ngcbCMD_PROTECTED)

◆ udata

void* ngcb_cmd_handle_t::udata

Forwarded user data.


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