RapidCodeSqNode Class Reference

The RapidCode SynqNet Node base class.

Inherits RapidCodeObject.

List of all members.

SqNode Info
char *	UserLabelGet ()
void	UserLabelSet (char *userLabel)
bool	Exists ()
	Check to see if an SqNode exists for this Axis.
long	NumberGet ()
char *	NameGet ()
	Get the name of the SqNode.
bool	ExactMatchGet ()
	Get the version status of the SqNode.
long	UniqueIDGet ()
	Get the unique identifier for the SqNode.
long	DriveCountGet ()
	Get the drive count for the SqNode.
long	MotorCountGet ()
	Get the number of motors on the SqNode.
long	MotorOffsetGet ()
	Get the starting number for the first motor on this SqNode.
RSINodeType	TypeGet ()
	Get the SqNode Type.
long	OptionGet ()
	Get the SqNode option number.
long	SwitchIDGet ()
	Get the SqNode switch identifier.
long	FPGATypeGet ()
	Get the SqNode FPGA Type.
long	FPGAVendorGet ()
	Get the SqNode FGPA Vendor data.
long	FPGAVersionGet ()
	Get the SqNode FPGA version.
long	FPGABranchVersionGet ()
	Get the SqNode FPGA Branch version.
bool	FPGADefaultVersionGet ()
char *	ModelNumberGet ()
	Get the SqNode model number info.
char *	SerialNumberGet ()
	Get the SqNode serial number info.
bool	StatusBitGet (RSIEventType bitMask)
	Get the state of an SqNode status bit.
SqNode I/O Info
long	DigitalInCountGet ()
	Get the number of digital input bits on the SqNode.
long	DigitalOutCountGet ()
	Get the number of digital output bits on the SqNode.
long	AnalogInCountGet ()
	Get the number of analog inputs on the SqNode.
long	AnalogOutCountGet ()
	Get the number of analog outputs on the SqNode.
long	SegmentCountGet ()
	Get the number of I/O segments on the SqNode.
long	DigitalInAddressGet (long bitNumber)
	Get the controller memory address for a Node's digital input.
long	DigitalInMaskGet (long bitNumber)
	Get the bitwise mask for a Node's digital input.
long	DigitalOutAddressGet (long bitNumber)
	Get the controller memory address for a Node's digital output.
long	DigitalOutMaskGet (long bitNumber)
	Get the bitwise mask for a Node's digital output.
long	AnalogInAddressGet (long channel)
	Get the controller memory address for a Node's analog input.
long	AnalogInMaskGet (long channel)
	Get the bitwise mask for a Node's analog input.
long	AnalogOutAddressGet (long channel)
	Get the controller memory address for a Node's analog output.
long	AnalogOutMaskGet (long channel)
	Get the bitwise mask for a Node's analog output.
SqNode UserFault
void	UserFaultEnable (bool state)
	Sets if an IO Abort will occur when the User Fault is triggered.
long	UserFaultAddressGet ()
	Get the SqNode User Fault address.
void	UserFaultAddressSet (long addresss)
	Set the SqNode User Fault address.
long	UserFaultMaskGet ()
	Get the SqNode User Fault mask value.
void	UserFaultMaskSet (long mask)
	Set the SqNode User Fault mask value.
long	UserFaultPatternGet ()
	Get the SqNode User Fault pattern.
void	UserFaultPatternSet (long mask)
	Set the SqNode User Fault pattern.
SqNode I/O Abort Configuration
bool	SynqLostEnableGet ()
	Returns if an IO fault will occur when the synqState is lost.
void	SynqLostEnableSet (bool state)
	Sets if an IO Abort will occur when the SynqState is lost.
bool	SynqLostInvertGet ()
	Returns the polarity of the SynqLost trigger.
void	SynqLostInvertSet (bool invert)
	Sets the polarity of the SynqLost trigger.
bool	NodeDisableEnableGet ()
	Returns the NodeDisable setting on IO Abort trigger.
void	NodeDisableEnableSet (bool state)
	Sets the NodeDisable setting on IO Abort trigger.
bool	NodeDisableInvertGet ()
	Returns the polarity of the Node Disable trigger.
void	NodeDisableInvertSet (bool invert)
	Sets the polarity of the NodeDisable trigger.
bool	PowerFaultEnableGet ()
	Returns if an IO fault will occur on a PowerFault.
void	PowerFaultEnableSet (bool state)
	Sets PowerFault enable/disable on IO Abort trigger.
bool	PowerFaultInvertGet ()
	Returns the polarity of the PowerFault trigger.
void	PowerFaultInvertSet (bool invert)
	Sets the polarity of the PowerFault trigger.
SqNode Drive Parameters
long	DriveParamGet (long param, RSIDriveMapParamType paramType)
	Get a drive parameter.
void	DriveParamSet (long param, RSIDriveMapParamType paramType, long value)
	Set drive parameters.
void	DriveParamClear ()
	Clear the drive parameters.
void	DriveParamCalculate ()
	Force the node to recalculate drive parameters.
void	DriveParamReload ()
	Reload the drive parameters from non-volatile storage on the drive.
void	DriveParamRestore ()
	Restore the drive parameters drive parameters from the drive factory defaults.
void	DriveParamStore ()
	Save the drive parameters to non-volatile storage on the drive.
SqNode Service Command
long	ServiceCommand (RSISqNodeChannel channel, RSISqNodeMemory memory, RSISqNodeDataSize size, RSISqNodeCmdType type, long address, long data)
	Send a service command to the node.
SqNode Download
char *	DefaultFileNameGet ()
void	Download (char *filename)
	Download a binary file FPGA image to the SqNode.
SqNode Status
long	UpstreamPacketErrorCountGet ()
	Gets the SqNode Upstream PacketError count.
long	DownstreamPacketErrorCountGet ()
	Gets the SqNode Downstream PacketError count.
long	CRCInErrorCountGet ()
	Gets the CRC error count on the In Port of the drive.
long	CRCOutErrorCountGet ()
	Gets the CRC error count on the Out Port of the drive.
Errors and Exceptions
long	ErrorLogCountGet ()
	Get the number of software errors in the error log.
RsiError *	ErrorLogGet ()
	Get the next RsiError in the log.
void	ErrorLogClear ()
	Clear the error log.
char *	RsiErrorMessageGet (RSIErrorMessage msg)
char *	ErrorMessageGet (RSIErrorMessage msg)
void	ErrorMsgCheck (RapidCodeObject *object, RSIErrorMessage msg, const char *function, long line)
void	ErrorMsgCheck (RapidCodeObject *object, RSIErrorMessage msg, const char *text, const char *function, long line)
Exceptions Enabled
void	ThrowExceptions (bool state)
	Configure a class to throw exceptions.
RapidCode Version
char *	VersionGet ()
	Get the RSI RapidCode version.

---

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

• rsi.h
• rsi.cpp