INOS
CINOSMcRobotAxis Class Reference

Public Types

enum  {
  eInitStandard = 0 , eInitBorder = 1 , eInitStall = 2 , eInitPosition = 3 ,
  eInitCustom = 4 , eInitShared = 5 , eInitNone = 6 , eInitStallWithTolerance = 7 ,
  eInitResolverAbsolute = 8 , eInitAbsoluteEncoder = 9 , eInitLua , eInitLast = 10
}
 
enum  {
  eFlgOn = 0x00000200 , eFlgInit = 0x00000400 , eFlgSlave = 0x08000000 , eFlgPureLimit = 0x10000000 ,
  eFlgShared = 0x20000000 , eFlgCoupled = 0x40000000 , eFlgSimulated = 0x80000000
}
 
enum  { eMonError = 0x00000001 , eMonWarning = 0x00000002 }
 
enum  {
  eStaIdle = 0 , eStaInit = 1 , eStaMove = 2 , eStaJoyStick = 3 ,
  eStaEndless = 4 , eStaWheel = 5 , eStaCalib = 6 , eStaMoveToBorder = 7 ,
  eStaMoveToBorderApp = 8 , eStaMoveToDigitalSensor = 9 , eStaMoveToAnalogSensor = 10 , eStaMoveSafe = 11 ,
  eStaMoveCarefully = 12 , eStaJoyStickDisabling = 13 , eStaMoveEx = 14 , eStaMovePath = 15
}
 
enum  { eRefNo = 0 , eRefYes = 1 , eRefYesOpposite = 2 , eRefYesDistanceCoded = 3 }
 
enum  { eRefSearchDefault = 0 , eRefSearchSingle = 1 , eRefSearchSafe = 2 , eRefSearchSafeController = 3 }
 
enum  { eJoyTypeDigital = 0 , eJoyTypeAnalog = 1 }
 

Public Member Functions

uint32 GetState ()
 get state
 
void SetState (uint32 auState)
 set state
 
void ResetState (uint32 auNewState, uint32 auOldState)
 reset state
 
bool GetFlag (uint32 auFlag) const
 get flag
 
void SetFlag (uint32 auFlag)
 set flag
 
void ClrFlag (uint32 auFlag)
 clear flag
 
bool GetOption (const char *apOption) const
 get option
 
uint32 GetSimLevel () const
 get simlevel
 
real64 GetSlowMotion () const
 get slowmotion factor
 
void SetSlowMotion (real64 arSlowMotion)
 set slowmotion factor
 
real64 GetMinPositionOn () const
 get minposition at on
 
real64 GetMaxPositionOn () const
 get maxposition at on
 
real64 GetPowerTimeout () const
 get power timeout
 
const charGetName () const
 get axis name
 
void SetName (const char *apName)
 set axis name
 
uint32 GetSourceId () const
 get source id
 
uint32 GetNumber () const
 get axis number
 
CINOSPhysicalAxisGetAxis () const
 get pointer axis
 
void SetAxis (CINOSPhysicalAxis *apAxis)
 set pointer axis
 
CINOSBitGetZero ()
 get pointer zero input
 
CINOSBitGetLimitPos () const
 get pointer limit pos input
 
bool CheckLimitPos () const
 check pos limit
 
CINOSBitGetLimitNeg () const
 get pointer limit neg input
 
bool CheckLimitNeg () const
 check neg limit
 
CINOSBitGetBrake () const
 get pointer brake
 
uint32 CheckError (bool abPostMessage=true)
 
uint32 CheckWarning (tMsgId &auMsgId)
 check actual axis warning
 
uint32 CheckConfig ()
 check axis config
 
SINOSRampParamGetRampParam (const char *apParam, SINOSRampParam *apResult=NULL)
 get ramp param (handles also names like e.g. Rapid[V=2.0 a=100.0])
 
void SaveLifetimeDistance ()
 save lifetime distance
 
uint32 GetInitType () const
 get init type
 
uint32 GetInitOrder () const
 get init order
 
uint32 GetInitDirection () const
 get init direction
 
uint32 GetInitEdge () const
 get init edge
 
uint32 GetInitCommutation () const
 get init post commutation support
 
uint32 GetInitBorder () const
 get init border support
 
uint32 GetInitReference () const
 get init reference support
 
uint32 GetInitReferenceSearchType () const
 get init reference search type
 
real64 GetInitReferenceSearchTol () const
 get init reference search tolerance
 
real64 GetInitReferenceSearchBack () const
 get init reference search back
 
real64 GetInitReferencePos () const
 get init reference position
 
void SetInitReferencePos (real64 arReferencePos)
 set init reference position
 
real64 GetInitReferenceTol () const
 get init reference tolerance
 
uint32 GetInitCurrentLimit () const
 get init currentlimit support
 
real64 GetInitMaxCurrent () const
 get init max current
 
real64 GetInitBorderLimit () const
 get init border limit
 
real64 GetInitZeroSlow () const
 get zero slowmotion
 
real64 GetInitZeroLeave () const
 get zero leave distance
 
real64 GetInitPos () const
 get init position
 
void SetInitPos (real64 arInitPos)
 set init position
 
real64 GetInitRange () const
 get init range
 
real64 GetInitSlaveBack () const
 get init slave backward
 
const charGetInitParam () const
 get init params
 
SINOSRampParamGetAdjInitParam ()
 get adjusted init params
 
uint32 GetInitMove () const
 get init reference support
 
real64 GetInitMovePos () const
 get init move
 
void SetInitMovePos (real64 arInitMovePos)
 set init move
 
const charGetInitMoveParam () const
 get init move param
 
uint32 GetCalibType () const
 get calib type
 
real64 GetCalibTolerance () const
 get calib tolerance
 
const charGetCalibParam () const
 get calib params
 
SINOSRampParamGetAdjCalibParam ()
 get adjusted calib params
 
bool HasBrake () const
 return true if axis has brake
 
int32 GetBrakeWaitOn () const
 get brake wait on
 
int32 GetBrakeWaitOff () const
 get brake wait off
 
void SetBrakeReleaseRequest (int32 aiMs)
 set brake release request
 
void DoBrake ()
 brake
 
void DoBrakeRelease ()
 brake release
 
uint32 GetJoyType () const
 get joy type
 
uint32 GetJoyWait () const
 get joy wait
 
uint32 GetJoyDeltaInc () const
 get joy delta inc
 
real64 GetJoyDeltaUnit () const
 get joy delta unit
 
const charGetJoyParam () const
 get joy param
 
uint32 GetWheelType () const
 get wheel type
 
real64 GetWheelFactor () const
 get wheel factor
 
void SetWheelFactor (real64 arFactor)
 set wheel factor
 
uint32 GetWheelFilterLength () const
 get wheel filter length
 
const charGetWheelParam () const
 get wheel param
 
const charGetWheelName () const
 get wheel name
 
void EnableMonitor (uint32 auType)
 enable monitor
 
void DisableMonitor (uint32 auType)
 disable monitor
 
uint32 GetMonitorEnabled (uint32 auType)
 get monitoring enabled
 
uint32 GetMonitorType () const
 get monitor type
 
uint32 GetMonitorActionError () const
 get monitor action
 
uint32 GetMonitorActionWarning () const
 get monitor warning
 
void SetWarningMsgId (tMsgId aId)
 set warning message id
 
virtual void AddProp (const char *apName, nvreal64 &aMember, real64 arDefault, real64 arMin, real64 arMax, const char *apUnit, uint32 auDigits)
 add nvreal property to the 'Prop' folder
 

Protected Member Functions

 CINOSMcRobotAxis (CINOSMcRobot *apModule, uint32 auNumber, const char *apAlias=0, const char *apParam=0)
 script constructor
 
virtual ~CINOSMcRobotAxis ()
 destructor
 
CINOSMcModuleGetModule ()
 get pointer to my module
 
CINCOObject * GetRegister (CINCOObject *apParent=0)
 get inco registration
 
void RegisterIO (CINCOObject *apParent)
 register axis IO's
 
bool HasLimit () const
 return true if axes has limit supervision
 
bool HasPosNegLimit () const
 return true if axes has pos/neg limit supervision
 
void CheckLimit ()
 do limitcheck
 
uint32 CheckLimit (real64 arPosition)
 do limitcheck
 
void Monitor ()
 monitor
 
void HndBrakeReleaseRequest ()
 handle brake release request
 
virtual bool DispatchReply (CINOSTaskExMsg *apMsg)
 dispatch reply message
 
void UpdateResource (const char *apName)
 update given axis resource
 
 DECLARE_DYNAMIC (CINOSMcRobotAxis)
 dynamic object handling
 

Protected Attributes

uint32 m_uState
 axis state
 
uint32 m_uStateCount
 state count
 
uint32 m_uFlags
 axis flags
 
CINOSMcRobotm_pModule
 pointer to my module
 
uint32 m_uNumber
 axis number
 
inosName64 m_cAlias
 axis name
 
char m_cParam [32]
 axis param
 
inosResName m_cName
 axis name
 
inosResName m_cZero
 zero input name
 
inosResName m_cBrake
 brake output name
 
inosResName m_cLimitPos
 zero input name
 
inosResName m_cLimitNeg
 zero input name
 
inosResName m_cJoyPos
 joystick pos name
 
inosResName m_cJoyNeg
 joystick neg name
 
inosResName m_cJoyAdc
 joystick adc name
 
inosResName m_cWheel
 wheel pos channel name
 
CINCOObject * m_pRegister
 pointer to axis properties folder
 
uint32 m_uOrder
 prop order
 
CINOSPhysicalAxism_pAxis
 pointer to axis
 
CINOSMcModuleResm_pAxisRes
 pointer to axis resource
 
CINOSBitm_pZero
 pointer to zero input
 
CINOSBitm_pBrake
 pointer to brake output
 
CINOSBitm_pLimitPos
 pointer to zero input
 
CINOSBitm_pLimitNeg
 pointer to zero input
 
CINOSBitm_pJoyPos
 pointer to joypos input
 
CINOSMcModuleResm_pJoyPosRes {}
 pointer to joypos resource
 
CINOSBitm_pJoyNeg
 pointer to joyneg input
 
CINOSMcModuleResm_pJoyNegRes {}
 pointer to joyneg resource
 
CINOSAdcChannelm_pJoyAdc
 pointer to joyadc channel
 
CINOSMcModuleResm_pJoyAdcRes {}
 pointer to joyadc resource
 
CINOSPosChannelm_pWheel
 pointer to wheel pos channel
 
CINOSMcModuleResm_pWheelRes {}
 pointer to wheel resource
 
SINOSRampParam m_sInitParam
 init param's rounded to a integral V value

 
SINOSRampParam m_sCalibParam
 calib param's rounded to a integral V value
 
nvuint32 m_uSimLevel
 sim level
 
nvreal64 m_rSlowMotion
 slowmotion factor
 
nvreal64 m_rLifetimeDistance
 lifetime distance
 
nvreal64 m_rMinPositionOn
 min. allowed position at 'on'
 
nvreal64 m_rMaxPositionOn
 max. allowed position at 'on'
 
nvreal64 m_rPowerTimeout
 power timeout
 
real64 m_rMinPosition
 min. position
 
real64 m_rMaxPosition
 max. position
 
bool m_bLimitPos
 pos limit reached
 
bool m_bLimitNeg
 neg limit reached
 
tMsgId m_LimitPosMsgId
 limit message id
 
tMsgId m_LimitNegMsgId
 
nvuint32 m_uInitType
 init type
 
char m_cInitGeneric [256]
 init generic parameter
 
nvuint32 m_uInitDirection
 init direction
 
nvuint32 m_uInitEdge
 init input edge
 
nvuint32 m_uInitCommutation
 init post commutation support
 
nvuint32 m_uInitBorder
 init border support
 
nvuint32 m_uInitReference
 init reference support
 
nvreal64 m_rInitReferencePos
 init reference position
 
nvreal64 m_rInitReferenceTol
 init reference tolerance
 
nvuint32 m_uInitReferenceSearchType
 init reference search type
 
nvreal64 m_rInitReferenceSearchTol
 init reference search tolerance
 
nvreal64 m_rInitReferenceSearchBack
 init reference search back
 
nvuint32 m_uInitCurrentLimit
 init currentlimit support
 
nvreal64 m_rInitMaxCurrent
 init max init current
 
nvreal64 m_rInitBorderLimit
 init borderlimit
 
nvreal64 m_rInitZeroSlow
 init zero search slowmotion factor
 
nvreal64 m_rInitZeroLeave
 init zero leave distance
 
nvreal64 m_rInitPos
 initial position
 
nvreal64 m_rInitRange
 init search range
 
nvreal64 m_rInitSlaveBack
 init slave backward
 
nvstring m_cInitParam
 init param
 
nvuint32 m_uInitMove
 init move support
 
nvreal64 m_rInitMovePos
 init move position
 
nvstring m_cInitMoveParam
 init move param
 
nvuint32 m_uCalibType
 calib type
 
nvreal64 m_rCalibTolerance
 calib tolerance
 
nvstring m_cCalibParam
 calib param
 
nvint32 m_iBrakeWaitOn
 brake wait on [ms]
 
nvint32 m_iBrakeWaitOff
 brake wait off [ms]
 
uint32 m_uBrakeReleaseRequest
 brake release request
 
CINOSxmsHandlerm_pBrakeReleaseHnd
 brake release handler
 
nvuint32 m_uJoyType
 joystick type
 
nvuint32 m_uJoyWait
 joystick wait [ms]
 
nvuint32 m_uJoyDeltaInc
 joystick delta [inc]
 
nvreal64 m_rJoyDeltaUnit
 joystick delta [unit]
 
nvstring m_cJoyParam
 joystick param
 
nvuint32 m_uWheelType
 wheel type
 
nvreal64 m_rWheelFactor
 wheel factor [*]
 
nvuint32 m_uWheelFilterLength
 wheel filter length
 
nvstring m_cWheelParam
 wheel param
 
uint32 m_uMonitorEnabled
 monitor enabled
 
uint32 m_uMonitorPending
 monitor pending
 
nvuint32 m_uMonitorType
 monitor enable request [0-no,1-error,2-warning,3-error/warning]
 
nvuint32 m_uMonitorActionError
 monitor action error [0-no,1-cancel,2-cancel parent]
 
nvuint32 m_uMonitorActionWarning
 monitor action warning [0-no,1-stop,2-stop parent]
 
tMsgId m_WarningMsgId
 warning message id
 
CINOSMcRobotAxism_pNext = nullptr
 pointer to next axis in list
 

Static Protected Attributes

static CINOSMutex m_Config
 

Friends

class CINOSMcRobot
 
class CINOSMcRobotCmdInit
 
class CINOSMcRobotCmdCalib
 
class CINOSMcRobotCmdMove
 
class CINOSMcRobotCmdLinear
 
class CINOSMcRobotCmdEndless
 

Member Function Documentation

◆ CheckError()

uint32 CINOSMcRobotAxis::CheckError ( bool  abPostMessage = true)

check actual axis error

Parameters
abPostMessageThis function generates an error message if set to true
Returns
The first found error. The function first checks for axis error bits (except the generic 'ramp' and 'control' failures) then checks the ramp error bits and finally the control error bits. Therefore, if a ramp and a control failure exists, only the ramp failure will be returned.

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