winIDEA SDK
isys::CFNetCtrl Class Reference

Description

FNet controller through which you get all of the FNet nodes.

#include <CFNetCtrl.h>

Inheritance diagram for isys::CFNetCtrl:
isys::WrapperBase

Public Member Functions

SPFNetAINCtrl AIN (const std::string &rstrID)
 Returns new instance of CFNetAINCtrl. More...
 
SPFNetAOUTCtrl AOUT (const std::string &rstrID)
 Returns new instance of CFNetAOUTCtrl. More...
 
SPFNetCANCtrl CAN (const std::string &rstrID)
 Returns new instance of CFNetCANCtrl. More...
 
SPFNetCounterCtrl COUNTER (const std::string &rstrID)
 Returns new instance of CFNetCounterCtrl. More...
 
void ctrl_inject_trigger (const uint8_t nFTrig)
 Manually generate (inject) specified FTrigger. More...
 
SPFNetDIOCtrl DIO (const std::string &rstrID)
 Returns new instance of CFNetDIOCtrl. More...
 
void get_configured_nodes (std::vector< SNodeInfo > &rvNodes)
 Returns all configured FNet nodes. More...
 
void get_connected_nodes (std::vector< SNodeInfo > &rvNodes)
 Returns all currently connected FNet nodes. More...
 
SPFNetLINCtrl LIN (const std::string &rstrID)
 Returns new instance of CFNetLINCtrl. More...
 
SPFNetmDIOCtrl mDIO (const std::string &rstrID)
 Returns new instance of CFNetmDIOCtrl. More...
 
void op_apply ()
 Performs the sequence of: stop, reapply operation configuration, restart FNet operation. More...
 
void op_restart ()
 Apply FNet configurations and restart internal state of all available nodes, without breaking communication with debugger. More...
 
void op_stop ()
 Stop FNet operation on all available nodes. More...
 
SPFNetSPICtrl SPI (const std::string &rstrID)
 Returns new instance of CFNetSPICtrl. More...
 

Member Function Documentation

◆ AIN()

SPFNetAINCtrl isys::CFNetCtrl::AIN ( const std::string &  rstrID)

Returns new instance of CFNetAINCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My ADIO.AIN1" or "ADIO box.Scope")

◆ AOUT()

SPFNetAOUTCtrl isys::CFNetCtrl::AOUT ( const std::string &  rstrID)

Returns new instance of CFNetAOUTCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My ADIO.AOUT1" or "ADIO box.Scope")

◆ CAN()

SPFNetCANCtrl isys::CFNetCtrl::CAN ( const std::string &  rstrID)

Returns new instance of CFNetCANCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My CAN2LIN2.CAN1" or "ADIO box.Scope")

◆ COUNTER()

SPFNetCounterCtrl isys::CFNetCtrl::COUNTER ( const std::string &  rstrID)

Returns new instance of CFNetCounterCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My Root.COUNTER" or "ADIO box.Scope")

◆ ctrl_inject_trigger()

void isys::CFNetCtrl::ctrl_inject_trigger ( const uint8_t  nFTrig)

Manually generate (inject) specified FTrigger.

Parameters
nFTrigin range from 1 to 10

◆ DIO()

SPFNetDIOCtrl isys::CFNetCtrl::DIO ( const std::string &  rstrID)

Returns new instance of CFNetDIOCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My ADIO.DIO" or "CAN box.Airbag")

◆ get_configured_nodes()

void isys::CFNetCtrl::get_configured_nodes ( std::vector< SNodeInfo > &  rvNodes)

Returns all configured FNet nodes.

Communication to the BlueBox must be established

Parameters
rvNodesconnected nodes list

◆ get_connected_nodes()

void isys::CFNetCtrl::get_connected_nodes ( std::vector< SNodeInfo > &  rvNodes)

Returns all currently connected FNet nodes.

Communication to the BlueBox must be established

Parameters
rvNodesconnected nodes list

◆ LIN()

SPFNetLINCtrl isys::CFNetCtrl::LIN ( const std::string &  rstrID)

Returns new instance of CFNetLINCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My CAN2LIN2.LIN1" or "ADIO box.Scope")

◆ mDIO()

SPFNetmDIOCtrl isys::CFNetCtrl::mDIO ( const std::string &  rstrID)

Returns new instance of CFNetmDIOCtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My AP.mDIO1" or "CAN box.Airbag")

◆ op_apply()

void isys::CFNetCtrl::op_apply ( )

Performs the sequence of: stop, reapply operation configuration, restart FNet operation.

Raises exception if FNet operation fails.

◆ op_restart()

void isys::CFNetCtrl::op_restart ( )

Apply FNet configurations and restart internal state of all available nodes, without breaking communication with debugger.

Raises exception if FNet operation fails.

◆ op_stop()

void isys::CFNetCtrl::op_stop ( )

Stop FNet operation on all available nodes.

Raises exception if FNet operation fails.

◆ SPI()

SPFNetSPICtrl isys::CFNetCtrl::SPI ( const std::string &  rstrID)

Returns new instance of CFNetSPICtrl.

Parameters
rstrIDthe IP identifier, constructed from
<FNode name>.<IP Name> 
(example: "My ADIO.SPI1" or "ADIO box.Scope")