winIDEA SDK
isys::CFNetCounterCtrl Class Reference

Description

FNet Counter controller.

Python example: fnet_counter.py

#include <CFNetCtrl.h>

Inheritance diagram for isys::CFNetCounterCtrl:
isys::CFNetIPCtrl isys::WrapperBase

Public Member Functions

SPOptionFNetCounterOp op ()
 Returns Counter option controller used for setting operation. More...
 
uint32_t ctrl_get_FTrig_count (const uint8_t nFTrig)
 Returns value of a counter of a chosen trigger. More...
 
void ctrl_reset_FTrig_count (const uint8_t nFTrig)
 Resets the counter for specified trigger. More...
 
void ctrl_reset (const uint8_t nChannel)
 Resets the counter for specified channel. More...
 
void ctrl_suspend (const uint8_t nChannel)
 Suspends the specified channel. More...
 
void ctrl_resume (const uint8_t nChannel)
 Resumes the specified channel. More...
 
SChannelStatus ctrl_get_status (const uint8_t nChannel)
 Gets status for the channel. More...
 
void op_qualifier_enable (uint8_t nFTrigEnable)
 Enables the trigger. More...
 
void op_qualifier_disable (uint8_t nFTrigDisable)
 Disables the trigger. More...
 
void op_qualifier_enable_on_start (bool bEnableFromStart)
 Enables the trigger from start. More...
 
void op_set_qualifier (bool bEnableFromStart, uint8_t nFTrigEnable, uint8_t nFTrigDisable)
 

Member Function Documentation

◆ ctrl_get_FTrig_count()

uint32_t isys::CFNetCounterCtrl::ctrl_get_FTrig_count ( const uint8_t  nFTrig)

Returns value of a counter of a chosen trigger.

This counter is incremented each time trigger is injected or asserted by other networks.

Parameters
nFTrigtrigger index in range from 0 to 15.
Returns
uint32_t counter value

◆ ctrl_get_status()

SChannelStatus isys::CFNetCounterCtrl::ctrl_get_status ( const uint8_t  nChannel)

Gets status for the channel.

Parameters
nChannelchannel index from 0 to 3 inclusive
Returns
SChannelStatus struct that holds status data for specified channel

◆ ctrl_reset()

void isys::CFNetCounterCtrl::ctrl_reset ( const uint8_t  nChannel)

Resets the counter for specified channel.

Parameters
nChannelchannel index from 0 to 3 inclusive

◆ ctrl_reset_FTrig_count()

void isys::CFNetCounterCtrl::ctrl_reset_FTrig_count ( const uint8_t  nFTrig)

Resets the counter for specified trigger.

Parameters
nFTrigtrigger index in range from 0 to 15 inclusive

◆ ctrl_resume()

void isys::CFNetCounterCtrl::ctrl_resume ( const uint8_t  nChannel)

Resumes the specified channel.

Parameters
nChannelchannel index from 0 to 3 inclusive

◆ ctrl_suspend()

void isys::CFNetCounterCtrl::ctrl_suspend ( const uint8_t  nChannel)

Suspends the specified channel.

Parameters
nChannelchannel index from 0 to 3 inclusive

◆ op()

SPOptionFNetCounterOp isys::CFNetCounterCtrl::op ( )

Returns Counter option controller used for setting operation.

Returns
COptionFNetCounterOp

◆ op_qualifier_disable()

void isys::CFNetIPCtrl::op_qualifier_disable ( uint8_t  nFTrigDisable)
inherited

Disables the trigger.

Parameters
nFTrigDisableset 0 for none, 1-10 inclusive for the specific trigger

◆ op_qualifier_enable()

void isys::CFNetIPCtrl::op_qualifier_enable ( uint8_t  nFTrigEnable)
inherited

Enables the trigger.

Parameters
nFTrigEnableset 0 for none, 1-10 inclusive for the specific trigger

◆ op_qualifier_enable_on_start()

void isys::CFNetIPCtrl::op_qualifier_enable_on_start ( bool  bEnableFromStart)
inherited

Enables the trigger from start.

Parameters
bEnableFromStartenable recording when it occurs

◆ op_set_qualifier()

void isys::CFNetIPCtrl::op_set_qualifier ( bool  bEnableFromStart,
uint8_t  nFTrigEnable,
uint8_t  nFTrigDisable 
)
inherited
Parameters
bEnableFromStartrecording is enabled at session start
nFTrigEnableset 0 for none, 1-10 inclusive for the specific trigger
nFTrigDisableset 0 for none, 1-10 inclusive for the specific trigger