isys::CFNetDIOCtrl Class Reference

Description

FNet Digital Input/Output controller.

Python example: fnet_dio.py

#include <CFNetCtrl.h>

Inheritance diagram for isys::CFNetDIOCtrl:

Public Member Functions
SFNetDIOInfo	info () const
	Returns information about the DIO IP. More...
SPOptionFNetDIOCfg	cfg ()
	Returns DIO Option controller used for setting configuration. More...
SPOptionFNetDIOOp	op ()
	Returns DIO Option controller used for setting operation. More...
void	ctrl_set_channel (const uint8_t nChannel, const bool bHi)
	Set pin state of chosen channel. More...
void	ctrl_set_channel (const std::string &rstrChannelName, const bool bHi)
	Set pin state of chosen channel. More...
bool	ctrl_get_channel (const uint8_t nChannel)
	Get pin state of chosen channel. More...
bool	ctrl_get_channel (const std::string &rstrChannelName)
	Get pin state of chosen channel. More...
void	ctrl_start_pattern (const uint8_t nPatternIndex)
	Starts the specified pattern. More...
void	ctrl_stop_pattern (const uint8_t nPatternIndex)
	Stops the specified pattern. 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

cfg()

SPOptionFNetDIOCfg isys::CFNetDIOCtrl::cfg

(

)

Returns DIO Option controller used for setting configuration.

Returns

COptionFNetDIOCfg

ctrl_get_channel() [1/2]

bool isys::CFNetDIOCtrl::ctrl_get_channel

(

const std::string &

rstrChannelName

)

Get pin state of chosen channel.

Parameters

rstrChannelName

Returns

bool channel state, true if High, false if Low

ctrl_get_channel() [2/2]

bool isys::CFNetDIOCtrl::ctrl_get_channel

(

const uint8_t

nChannel

)

Get pin state of chosen channel.

Parameters

nChannel

Returns

bool channel state, true if High, false if Low

ctrl_set_channel() [1/2]

void isys::CFNetDIOCtrl::ctrl_set_channel	(	const std::string &	rstrChannelName,
		const bool	bHi
	)

Set pin state of chosen channel.

Parameters

rstrChannelName
bHi	true to set the channel High, false to Low You can only set pin state if channel's bank is configured as output, otherwise this function call has no effect.

ctrl_set_channel() [2/2]

void isys::CFNetDIOCtrl::ctrl_set_channel	(	const uint8_t	nChannel,
		const bool	bHi
	)

Set pin state of chosen channel.

Parameters

nChannel
bHi	true to set the channel High, false to Low You can only set pin state if channel's bank is configured as output, otherwise this function call has no effect.

ctrl_start_pattern()

void isys::CFNetDIOCtrl::ctrl_start_pattern

(

const uint8_t

nPatternIndex

)

Starts the specified pattern.

Parameters

nPatternIndex

ctrl_stop_pattern()

void isys::CFNetDIOCtrl::ctrl_stop_pattern

(

const uint8_t

nPatternIndex

)

Stops the specified pattern.

Parameters

nPatternIndex

info()

SFNetDIOInfo isys::CFNetDIOCtrl::info

(

)

const

Returns information about the DIO IP.

Returns

SFNetDIOInfo {m_nNumBanks, m_nNumChannels}

op()

SPOptionFNetDIOOp isys::CFNetDIOCtrl::op

(

)

Returns DIO Option controller used for setting operation.

Returns

COptionFNetDIOOp

op_qualifier_disable()

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

inherited

Disables the trigger.

Parameters

nFTrigDisable

set 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

nFTrigEnable

set 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

bEnableFromStart

enable recording when it occurs

op_set_qualifier()

void isys::CFNetIPCtrl::op_set_qualifier ( bool  bEnableFromStart, uint8_t  nFTrigEnable, uint8_t  nFTrigDisable  )

inherited

Parameters

bEnableFromStart	recording is enabled at session start
nFTrigEnable	set 0 for none, 1-10 inclusive for the specific trigger
nFTrigDisable	set 0 for none, 1-10 inclusive for the specific trigger