isys::CFNetController Class Reference

Description

FNet controller.

#include <CFNetController.h>

Inheritance diagram for isys::CFNetController:

Public Member Functions
CFNetCounterControllerSPtr	createCounterController (const std::string &identifier="Root.COUNTER1")
	Returns new instance of CFNetCounterController. More...
CFNetDIOControllerSPtr	createDIOController (const std::string &identifier)
	Returns new instance of CFNetDIOController. More...
CFNetSPIControllerSPtr	createSPIController (const std::string &identifier)
	Returns new instance of CFNetSPIController. More...
CFNetAOutControllerSPtr	createAOutController (const std::string &identifier)
	Returns new instance of CFNetAOutController. More...
CFNetAInControllerSPtr	createAInController (const std::string &identifier)
	Returns new instance of CFNetAInController. More...
CFNetPowerSenseControllerSPtr	createPowerSenseController (const std::string &identifier="ADIO.AIN1")
	Returns new instance of CFNetPowerSenseController. More...
CFNetCANControllerSPtr	createCANController (const std::string &identifier)
	Returns new instance of CFNetCANController. More...
CFNetLINControllerSPtr	createLINController (const std::string &identifier)
	Returns new instance of CFNetLINController. More...
void	injectTrigger (const uint8_t triggerIndex)
	Manually generate (inject) selected trigger. More...
void	getListOfConnectedNodes (std::vector< std::string > &nodes)
	Fills list with available FNet nodes. More...
std::string	getNodeAttributes (const std::string &nodeName, bool raiseException=false)
	Returns string of node attributes. More...
int16_t	getTriggerIndex (const std::string &triggerName)
	Returns trigger index. More...
void	applyOperation ()
	Performs the sequence of: stop, reapply operation configuration, restart FNet operation. More...
void	stopOperation ()
	Stop FNet operation on all available nodes. More...
void	restartOperation ()
	Apply FNet configurations and restart internal state of all available nodes, without breaking communication with debugger. More...

Protected Member Functions
uint32_t	getServerVersion ()
	Returns server (winIDEA) version of isystem.connect interface. More...
std::string	getLastError ()
	This function returns error description, after isystem.connect call fails. More...
CLogger *	log ()
	Returns logger, which can be used for logging.
bool	isLog ()
	Returns true, if logging is active.

Member Function Documentation

applyOperation()

void isys::CFNetController::applyOperation

(

)

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

Raises exception if FNet operation fails.

createAInController()

CFNetAInControllerSPtr isys::CFNetController::createAInController

(

const std::string &

identifier

)

Returns new instance of CFNetAInController.

Parameters

identifier

unique network identifier string (example: "ADIO.AIN1")

createAOutController()

CFNetAOutControllerSPtr isys::CFNetController::createAOutController

(

const std::string &

identifier

)

Returns new instance of CFNetAOutController.

Parameters

identifier

unique network identifier string (example: "ADIO.AOUT1")

createCANController()

CFNetCANControllerSPtr isys::CFNetController::createCANController

(

const std::string &

identifier

)

Returns new instance of CFNetCANController.

Parameters

identifier

unique network identifier string (example: "CAN2LIN2.CAN1")

createCounterController()

CFNetCounterControllerSPtr isys::CFNetController::createCounterController

(

const std::string &

identifier = "Root.COUNTER1"

)

Returns new instance of CFNetCounterController.

Parameters

identifier

unique network identifier string (example: "Root.COUNTER1")

createDIOController()

CFNetDIOControllerSPtr isys::CFNetController::createDIOController

(

const std::string &

identifier

)

Returns new instance of CFNetDIOController.

Parameters

identifier

unique network identifier string (example: "ADIO.DIO")

createLINController()

CFNetLINControllerSPtr isys::CFNetController::createLINController

(

const std::string &

identifier

)

Returns new instance of CFNetLINController.

Parameters

identifier

unique network identifier string (example: "CAN2LIN2.LIN1")

createPowerSenseController()

CFNetPowerSenseControllerSPtr isys::CFNetController::createPowerSenseController

(

const std::string &

identifier = "ADIO.AIN1"

)

Returns new instance of CFNetPowerSenseController.

Parameters

identifier

unique network identifier string (example: "ADIO.AIN1")

createSPIController()

CFNetSPIControllerSPtr isys::CFNetController::createSPIController

(

const std::string &

identifier

)

Returns new instance of CFNetSPIController.

Parameters

identifier

unique network identifier string (example: "ADIO.SPI1")

getLastError()

std::string isys::WrapperBase::getLastError ( )

protectedinherited

This function returns error description, after isystem.connect call fails.

The description is the same, as it would be shown in a winIDEA's message dialog. If there is no error message available, an empty string is returned.

getListOfConnectedNodes()

void isys::CFNetController::getListOfConnectedNodes

(

std::vector< std::string > &

nodes

)

Fills list with available FNet nodes.

Parameters

nodes

connected nodes list

getNodeAttributes()

std::string isys::CFNetController::getNodeAttributes	(	const std::string &	nodeName,
		bool	raiseException = false
	)

Returns string of node attributes.

Parameters

nodeName	node name as specified in winIDEA GUI
raiseException	if true, exception is raised if node can't be found, otherwise not

Returns

string of node attributes

getServerVersion()

uint32_t isys::WrapperBase::getServerVersion ( )

protectedinherited

Returns server (winIDEA) version of isystem.connect interface.

Attach must be done before this method returns valid result. Value of iConnect::EVersion::verCurrent in winIDEA is returned.

getTriggerIndex()

int16_t isys::CFNetController::getTriggerIndex

(

const std::string &

triggerName

)

Returns trigger index.

Parameters

triggerName

name like in winIDEA GUI window. For example: "TC5", "None", "RunSync"

Returns

index number, if no index can be found for the given name, then -1 is returned.

injectTrigger()

void isys::CFNetController::injectTrigger

(

const uint8_t

triggerIndex

)

Manually generate (inject) selected trigger.

Parameters

triggerIndex

index in range from 0 to 10

restartOperation()

void isys::CFNetController::restartOperation

(

)

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

Raises exception if FNet operation fails.

stopOperation()

void isys::CFNetController::stopOperation

(

)

Stop FNet operation on all available nodes.

Raises exception if FNet operation fails.