Contents Menu Expand Light mode Dark mode Auto light/dark mode
PMP documentation
Light Logo Dark Logo
  • Software
    • Quick start
      • Installation
        • Windows
        • Linux
      • Tooling
        • Create a simulator
        • Closed-loop system
      • API
        • Project configuration
          • C++
          • C#
          • Python .NET
            • General Python .NET interfacing
          • MATLAB .NET
            • General MATLAB .NET Interfacing
        • Create a simulator
        • Closed-loop system
    • Guides
      • Control loop customization
        • Simulink code generation
        • Custom C/C++ code
        • Deployment
          • Motion controllers
          • EtherCAT SubDevices
        • Debugging
          • Logging
      • Position based trigger
      • Persistent configuration
    • General concepts
      • Considerations
        • C++
        • C#
      • Acquisition
      • Actuator
      • Alignment
        • Method AbsoluteAngle
        • Method AbsoluteOffset
        • Method KickAndSwing
        • Method CatchAndMove
        • Method WakeAndShake
      • Axis control
      • Axis control group
      • Bus
      • Command
      • Command sequence
      • Command queue
      • Condition
      • Controller
      • Event
      • Event response
      • Filter
        • PIDLowPass
        • Integrator
        • GenericFilter
      • Homing
        • Method AbsolutePosition
        • Method AbsoluteOffset
        • Method IndexPulse
        • Method LimitSwitch
        • Method AreaSwitch
        • Method EndStop
      • Input
      • Latch
      • Log buffer
      • Matrix
      • Named
      • Object
      • Parameter set
      • Power state machine
      • Processing block
        • Execution type
        • Execution period
        • Diagnostics
      • Sensor
      • Signal
      • Snapshot
      • State machine
      • Sub-controller
      • Subscription
      • System
        • Simulation
      • Template
      • Top-controller
      • Trajectory generator
      • Trajectory interpolator
      • Updatable
    • Reference manuals
      • Tooling
        • General
        • Network explorer
        • Signals view
        • Signal groups view
        • Log view
        • Event view
        • Scope view
        • Command sequence view
        • State machine view
        • HMI view
      • API
        • C#
          • Classes
            • EtherCat
              • State
            • IoBus
              • State
            • SimulatorSettings
            • System
          • Delegates
            • AcqCompleteHandler
            • AcquisitionCompleteHandler
            • AcquisitionErrorHandler
            • AcquisitionNextHandler
            • AcquisitionTriggerHandler
            • AsynchronousExceptionHandler
            • CommandSequenceCompleteHandler
            • ComputationStateHandler
            • ConnectionHandler
            • ConnectionLostHandler
            • EventOccurredHandler
            • EventResponseHandler
            • LatchTriggeredHandler
            • LogReaderRemainingCapacityHandler
            • ObjectChildAddedHandler
            • ObjectChildRemovedHandler
            • ObjectPropertyChangedHandler
            • SignalMatchHandler
            • StateMachineStateHandler
            • TopControllerStateChangeHandler
            • UpdatableCompleteHandler
            • UpdatableProgressHandler
          • Enums
            • AcqFileFormat
            • AcqSinkMode
            • AcquisitionState
            • AcquisitionTriggerMode
            • AcquisitionTriggerOccurrenceType
            • AlignmentMethod
            • AlignmentState
            • AxisControlState
            • BusType
            • CommandQueuePriority
            • CommandQueueState
            • CommandState
            • CommandSyncMode
            • CommandType
            • CompletionCriterion
            • ComputationState
            • ConditionType
            • CpuUtilization
            • Endpoint
            • ExecutionType
            • FilterDiscretization
            • FilterType
            • ForceType
            • FrameRotationType
            • FrameTranslationType
            • GenericFilterSubType
            • GeometryType
            • HomingDirection
            • HomingMethod
            • HomingState
            • InjectionType
            • JointType
            • LatchState
            • LatchTriggerMode
            • LatchTriggerType
            • LogCategory
            • ObjectType
            • PowerState
            • Property
            • RobotCreationState
            • SegmentType
            • SettlingState
            • SignalDataType
            • SignalOperator
            • SnapshotMode
            • State
            • TemplateType
            • TopControllerState
            • TrajectoryState
            • ValueType
          • Exceptions
            • AbortedException
            • AccessDeniedException
            • ChecksumErrorException
            • CommunicationErrorException
            • ConnectionLostException
            • ConnectionRefusedException
            • IncompatibleException
            • InvalidArgumentException
            • InvalidConfigException
            • InvalidFormatException
            • InvalidOperationException
            • NotImplementedException
            • NullArgumentException
            • OutOfResourcesException
            • PmpException
              • Methods
                • ToString
              • Properties
                • Time
                • InnerExceptions
                • Values
                • Format
                • Id
                • TimeStamp
            • ReadErrorException
            • RebootedException
            • ResourceBusyException
            • TimeoutException
            • UnexpectedException
            • UnknownObjectException
            • UnsupportedException
            • WriteErrorException
          • Interfaces
            • EtherCat.IBus
              • Properties
                • TypedControllers
                • StateMachine
            • EtherCat.ISubController
              • Properties
                • StateMachine
            • IAbsMove
              • Properties
                • Configuration
            • IAcqSink
              • Methods
                • SubscribeComplete
                • WaitComplete
                • WriteToFile
              • Properties
                • SinkMode
                • TriggerOccurrences
                • Samples
                • Capacity
                • SampleCount
            • IAcquisition
              • Methods
                • ReserveAcqSink
                • SubscribeComplete
                • SubscribeError
                • SubscribeNext
                • SubscribeTriggerStart
                • SubscribeTriggerStop
                • Prepare
                • Start
                • Stop
              • Properties
                • State
                • IsRunning
                • Interval
                • OnNextInterval
                • Signals
                • Trigger
            • IAcquisitionSignalCollection
              • Properties
                • WithInterval
            • IAcquisitionTrigger
              • Properties
                • TriggerMode
                • PostSampleDuration
                • PreSampleDuration
                • StartCondition
                • StopCondition
            • IActuator
              • Methods
                • GetAlignment
              • Properties
                • Filters
                • Inputs
                • Signals
                • Updatables
                • PowerStateMachine
            • IAlignment
              • Methods
                • Reset
                • Start
              • Properties
                • Method
                • Timeout
                • Inputs
                • Signals
                • SupportedMethods
                • StateMachine
                • RunException
            • IApplyParameterSet
              • Properties
                • ParameterSets
            • IAxisControl
              • Methods
                • GetHoming
                • CreateParameterSet
                • CreateProcessingBlock
              • Properties
                • ParameterSets
                • ProcessingBlocks
                • TrajectoryGenerator
                • TrajectoryInterpolator
            • IAxisControlBase
              • Methods
                • SubscribeRootError
                • ResetFault
              • Properties
                • RootError
                • CommandQueue
                • Signals
                • Errors
                • StateMachine
            • IAxisControlGroup
              • Methods
                • PauseAxis
                • ResumeAxis
              • Properties
                • AxisControls
            • IBus
              • Methods
                • CreateController
                • CreateControllerFromFile
              • Properties
                • BusType
                • Signals
                • Controllers
            • ICloseLoop
            • ICommandBase
              • Properties
                • State
                • RunException
                • Id
            • ICommandGroup
              • Methods
                • CreateCommands
              • Properties
                • SyncMode
                • Commands
            • ICommandQueue
              • Methods
                • CreateCommandSequence
                • CreateCommandSequence
                • Clear
                • Continue
                • Queue
              • Properties
                • FailedCommand
                • Inputs
                • Signals
                • SupportedCommandTypes
                • Sequences
                • StateMachine
                • Depth
            • ICommandSequence
              • Methods
                • SubscribeComplete
                • Reuse
                • WaitComplete
              • Properties
                • State
                • Commands
                • FailedCommands
            • ICommandSequenceEventResponse
              • Methods
                • Abort
              • Properties
                • Sequence
            • ICondition
              • Properties
                • Negate
                • ConditionType
            • IController
              • Methods
                • CreateAxisControl
                • CreateAxisControlGroup
                • CreateMatrix
                • CreateProcessingBlock
                • SubscribeConnection
                • SubscribeConnectionLost
                • CreateTemplate
                • SaveConfiguration
                • CreateController
                • CreateControllerFromFile
                • LoadConfiguration
                • LoadConfiguration
                • LoadConfigurationFromFile
                • LoadConfigurationFromFile
                • Reboot
                • SaveConfigurationToFile
              • Properties
                • IsBackupRunning
                • IsCompatible
                • IsConnected
                • IsRebootRequired
                • IsSimulated
                • Actuators
                • AxisControls
                • AxisControlGroups
                • Buses
                • Latches
                • Matrices
                • ProcessingBlocks
                • Sensors
                • Signals
                • Controllers
                • Templates
                • Updatables
                • LogBuffer
                • Address
                • HardwareInterfaceProductNumber
                • HardwareProductNumber
                • HardwareSerialNumber
                • Id
            • IDictionary
              • Properties
                • Keys
                • Values
                • This[K key]
            • IDisableOperation
            • IDisableVoltage
            • IEnableOperation
            • IEvent
              • Methods
                • Subscribe
                • Force
              • Properties
                • ContextEnabled
                • Signals
            • IEventResponder
              • Methods
                • SubscribeResponses
              • Properties
                • Responses
            • IEventResponse
              • Methods
                • Subscribe
              • Properties
                • Events
                • PropagatingEventResponses
                • Signals
            • IEventSource
              • Methods
                • SubscribeEvents
                • Force
              • Properties
                • Events
            • IFilter
              • Properties
                • Discretization
                • FilterType
                • Signals
            • IFrame
              • Properties
                • Signals
                • ReferenceFrame
                • Rotation
                • Translation
            • IFrameObserver
            • IFrameRotation
              • Properties
                • FrameRotationType
            • IFrameTranslation
              • Properties
                • FrameTranslationType
            • IGeometry
              • Methods
                • CreateFrame
              • Properties
                • GeometryType
                • Frames
                • Signals
                • Config
            • IGeometryConfig
              • Properties
                • Type
            • IGeometryMassConfig
              • Properties
                • Mass
            • IHoming
              • Methods
                • Reset
                • Start
              • Properties
                • Timeout
                • Method
                • Inputs
                • Signals
                • SupportedMethods
                • StateMachine
                • RunException
            • IInput
              • Properties
                • Signals
                • Source
            • IJog
              • Properties
                • Configuration
            • IJoint
              • Properties
                • AxisControl
                • Signals
                • OutputFrame
                • ReferenceFrame
                • JointType
            • ILatch
              • Methods
                • WaitTrigger
                • SubscribeTrigger
                • Disable
                • Enable
              • Properties
                • Inputs
                • Signals
                • StateMachine
                • TriggerMode
                • TriggerType
            • ILockableParameterSet
            • ILogBuffer
              • Methods
                • ReserveLogReader
                • AddMessage
              • Properties
                • Categories
            • ILogReader
              • Methods
                • SubscribeRemainingCapacity
                • Read
                • Clear
              • Properties
                • RemainingCapacity
            • IMatrix
              • Properties
                • Values
                • Inputs
                • Signals
                • Dimensions
            • IMoveCommand
              • Properties
                • CompletionCriterion
            • INamed
              • Methods
                • GetByDefaultName
                • GetByDefaultPath
                • GetByPath
              • Properties
                • Children
                • DefaultName
                • FullName
                • Name
            • IObject
              • Properties
                • Parent
                • Type
            • IoBus.IBus
              • Properties
                • TypedControllers
                • StateMachine
            • IoBus.ISubController
              • Properties
                • StateMachine
            • IOpenLoop
            • IParameterSet
              • Methods
                • Apply
            • IParameterSetBase
              • Methods
                • SetValues
              • Properties
                • Signals
            • IPathMove
              • Methods
                • SubscribeComputationState
                • AppendSegments
                • ClearSegments
                • Precompute
                • ReplaceSegments
                • SetSegments
                • WaitComputationState
              • Properties
                • ComputationState
                • RemainingSegments
                • ReferenceFrame
                • TargetFrame
                • ComputationException
                • StartConditions
            • IProcessingBlock
              • Properties
                • CalculationStart
                • ExecutionBudget
                • Period
                • ExecutionType
                • Filters
                • Inputs
                • Signals
                • Updatables
            • IQuickStop
            • IRelMove
              • Properties
                • Configuration
            • IRigidBody
              • Methods
                • CreateFrame
                • CreateGeometry
                • CreateJoint
              • Properties
                • Frames
                • Geometries
                • Joints
                • Signals
            • IRobot
              • Methods
                • CreateParameterSet
                • CreateRigidBody
                • CompleteCreation
              • Properties
                • AxisControlGroup
                • ParameterSets
                • RigidBodies
                • Signals
                • CreationState
            • ISample
              • Properties
                • Timestamp
                • Signals
                • StreamPosition
            • ISegment
              • Properties
                • ConstantVelocity
                • EndDeviationZoneRadius
                • StartDeviationZoneRadius
                • ToleranceRadius
                • ParameterSets
                • SegmentType
                • UserId
                • Target
            • ISensor
              • Properties
                • Filters
                • Inputs
                • Signals
                • Updatables
                • PowerStateMachine
            • ISetSignal
              • Properties
                • ConfigurationDouble
                • ConfigurationUint32
            • IShutdown
            • ISignal
              • Methods
                • SubscribeMatch
                • SubscribeMatch
                • WaitMatch
                • WaitMatch
              • Properties
                • IsWritable
                • LowerBound
                • UpperBound
                • ValueDouble
                • Translations
                • DataType
                • Description
                • Unit
                • ValueUint32
            • ISmoothStop
            • ISnapshot
              • Properties
                • Signals
                • Sample
            • IStateMachine
              • Methods
                • SubscribeState
                • WaitState
              • Properties
                • Signals
                • State
            • ISubController
              • Methods
                • ApplyModel
                • ApplyModelFromFile
              • Properties
                • BusType
                • BusToParent
            • ISubscription
              • Methods
                • Unsubscribe
            • ISwitchOn
            • ISystem
              • Methods
                • SubscribeConnection
                • SubscribeConnectionLost
                • SubscribeObjectChildAdded
                • SubscribeObjectChildRemoved
                • SubscribeObjectPropertyChanged
                • CreateController
                • CreateControllerFromFile
                • CreateControllers
                • CreateControllersFromFile
                • Discover
              • Properties
                • DiscoveryInterval
                • ExpirationTime
                • Controllers
                • LogBuffer
                • Version
            • ITemplate
              • Properties
                • IsMutable
                • Updatable
                • TemplateType
            • ITopController
              • Methods
                • ReserveAcquisition
                • CreateRobot
                • CreateRobotFromFile
                • CreateRobotFromString
                • ReserveSnapshot
                • SubscribeAsynchronousException
                • SubscribeStateChange
                • GetKeepAliveSettings
                • ApplyModel
                • ApplyModelFromFile
                • Run
                • SetKeepAliveSettings
                • Stop
                • WaitState
              • Properties
                • Time
                • Robots
                • WorldFrame
                • State
            • ITrajectoryGenerator
              • Properties
                • Signals
            • ITrajectoryInterpolator
              • Properties
                • Inputs
                • Signals
                • StateMachine
            • ITriggerMatchSignal
              • Properties
                • Configuration
            • IUpdatable
              • Methods
                • SubscribeComplete
                • SubscribeProgress
                • LoadContentsFromFile
                • SaveContentsToFile
                • WaitComplete
              • Properties
                • Contents
                • MaxSize
                • ProductNumber
                • Version
            • IWaitDuration
              • Properties
                • Duration
            • IWaitMatchSignal
              • Properties
                • ConfigurationDouble
                • ConfigurationUint32
          • Namespaces
            • Helpers
            • Unmanaged
          • Structs
            • AcquisitionTriggerOccurrence
              • Properties
                • Type
                • SignalValues
                • StreamPosition
            • BezierCurveSegment
              • Properties
                • Controlpoints
            • CartesianTranslation
              • Properties
            • ConstantVelocity
              • Properties
                • Magnitude
                • Tolerance
            • CylindricalTranslation
              • Properties
                • Theta
            • DirectionVector
              • Properties
            • DirectionVectorRotation
              • Properties
                • DirectionVector
                • Angle
            • DirectionVectorRotationSeries
              • Properties
                • RotationSeries
            • DoubleCondition
              • Properties
                • Value
                • Operator
            • EventOccurrence
              • Properties
                • Event
                • Context
            • GenericMassConfig
              • Properties
                • Ixx
                • Ixy
                • Ixz
                • Iyy
                • Iyz
                • Izz
            • KeepAliveSettings
              • Properties
                • IdleTimeout
                • ProbeInterval
                • ProbeCount
            • SignalCondition
              • Properties
                • Negate
                • ConditionType
                • Signal
                • Operator
                • Value
            • SignalValue
              • Methods
                • Operator bool
                • Operator double
                • Operator float
                • Operator SignalValue
                • Operator SignalValue
                • Operator SignalValue
                • Operator SignalValue
                • Operator uint
            • SimulatedControllerProperties
            • SphericalTranslation
              • Properties
                • Phi
                • Theta
            • TrivialCondition
              • Properties
                • Negate
                • Value
                • ConditionType
            • Uint32Condition
              • Properties
                • Operator
                • Mask
                • Value
            • Value
            • Version
              • Properties
                • Major
                • Minor
                • Patch
                • Build
                • Info
            • Waypoint
              • Properties
                • Position
        • C++
          • Classes
            • CSystem
            • EAcqFileFormat
              • Functions
                • Convert
            • EAcqSinkMode
              • Functions
                • Convert
            • EAcquisitionState
              • Functions
                • Convert
            • EAcquisitionTriggerMode
              • Functions
                • Convert
            • EAcquisitionTriggerOccurrenceType
              • Functions
                • Convert
            • EAlignmentMethod
              • Functions
                • Convert
            • EAlignmentState
              • Functions
                • Convert
            • EAxisControlState
              • Functions
                • Convert
            • EBusType
              • Functions
                • Convert
            • ECommandCompletionCriterion
              • Functions
                • Convert
            • ECommandQueuePriority
              • Functions
                • Convert
            • ECommandQueueState
              • Functions
                • Convert
            • ECommandState
              • Functions
                • Convert
            • ECommandSyncMode
              • Functions
                • Convert
            • ECommandType
              • Functions
                • Convert
            • EComputationState
              • Functions
                • Convert
            • EConditionType
              • Functions
                • Convert
            • ECpuUtilization
              • Functions
                • Convert
            • EEndpoint
              • Functions
                • Convert
            • EEnumBase
              • Functions
                • Operator T
                • ToString
            • EEtherCatState
              • Functions
                • Convert
            • EExecutionType
              • Functions
                • Convert
            • EFilterDiscretization
              • Functions
                • Convert
            • EFilterType
              • Functions
                • Convert
            • EForceType
              • Functions
                • Convert
            • EFrameRotationType
              • Functions
                • Convert
            • EFrameTranslationType
              • Functions
                • Convert
            • EGenericFilterSubType
              • Functions
                • Convert
            • EGeometryType
              • Functions
                • Convert
            • EHomingDirection
              • Functions
                • Convert
            • EHomingMethod
              • Functions
                • Convert
            • EHomingState
              • Functions
                • Convert
            • EInjectionType
              • Functions
                • Convert
            • EIoBusState
              • Functions
                • Convert
            • EJointType
              • Functions
                • Convert
            • ELatchState
              • Functions
                • Convert
            • ELatchTriggerMode
              • Functions
                • Convert
            • ELatchTriggerType
              • Functions
                • Convert
            • ELogCategory
              • Functions
                • Convert
            • EObjectType
              • Functions
                • Convert
            • EPowerState
              • Functions
                • Convert
            • EProperty
              • Functions
                • Convert
            • ERobotCreationState
              • Functions
                • Convert
            • ESegmentType
              • Functions
                • Convert
            • ESettlingState
              • Functions
                • Convert
            • ESignalDataType
              • Functions
                • Convert
            • ESignalOperator
              • Functions
                • Convert
            • ESnapshotMode
              • Functions
                • Convert
            • ETemplateType
              • Functions
                • Convert
            • ETopControllerState
              • Functions
                • Convert
            • ETrajectoryState
              • Functions
                • Convert
            • EValueType
              • Functions
                • Convert
          • Exceptions
            • CAbortedException
            • CAccessDeniedException
            • CChecksumErrorException
            • CCommunicationErrorException
            • CConnectionLostException
            • CConnectionRefusedException
            • CIncompatibleException
            • CInvalidArgumentException
            • CInvalidConfigException
            • CInvalidFormatException
            • CInvalidOperationException
            • CNotImplementedException
            • CNullArgumentException
            • CObjectDestroyedException
            • COutOfResourcesException
            • CPmpException
              • Functions
                • What
                • GetTime
                • GetValues
                • GetFormat
                • ToString
                • GetInnerExceptions
                • GetId
                • GetTimeStamp
            • CReadErrorException
            • CRebootedException
            • CResourceBusyException
            • CTimeoutException
            • CUnexpectedException
            • CUnknownObjectException
            • CUnsupportedException
            • CWriteErrorException
            • PPmpException
          • Functions
            • CreateSystem
          • Interfaces
            • EtherCat::IBus
              • Functions
                • GetStateMachine
                • GetTypedControllers
            • EtherCat::ISubController
              • Functions
                • GetStateMachine
            • IAbsMove
              • Functions
                • GetConfiguration
                • SetConfiguration
            • IAcqSink
              • Functions
                • GetSinkMode
                • GetCapacity
                • SubscribeComplete
                • GetSamples
                • GetTriggerOccurrences
                • GetSampleCount
                • WaitComplete
                • WriteToFile
            • IAcquisition
              • Functions
                • IsRunning
                • GetInterval
                • GetOnNextInterval
                • GetState
                • ReserveAcqSink
                • GetTrigger
                • SubscribeComplete
                • SubscribeError
                • SubscribeNext
                • SubscribeTriggerStart
                • SubscribeTriggerStop
                • GetSignalsWithInterval
                • AddSignalWithInterval
                • Prepare
                • SetInterval
                • SetOnNextInterval
                • Start
                • Stop
            • IAcquisitionTrigger
              • Functions
                • GetStartCondition
                • GetStopCondition
                • GetPostSampleDuration
                • GetPreSampleDuration
                • GetTriggerMode
                • SetPostSampleDuration
                • SetPreSampleDuration
                • SetStartCondition
                • SetStopCondition
                • SetTriggerMode
            • IActuator
              • Functions
                • GetAlignment
                • GetFilter
                • GetInput
                • GetPowerStateMachine
                • GetSignal
                • GetUpdatable
                • GetFilters
                • GetInputs
                • GetSignals
                • GetUpdatables
                • GetFilterNames
                • GetInputNames
                • GetSignalNames
                • GetUpdatableNames
            • IAlignment
              • Functions
                • GetTimeout
                • GetMethod
                • GetStateMachine
                • GetInput
                • GetRunException
                • GetSignal
                • GetInputs
                • GetSignals
                • GetSupportedMethods
                • GetInputNames
                • GetSignalNames
                • Reset
                • SetMethod
                • SetTimeout
                • Start
            • IApplyParameterSet
              • Functions
                • ContainsParameterSet
                • RemoveParameterSet
                • GetParameterSetCount
                • GetParameterSets
                • AddParameterSet
                • ClearParameterSets
            • IAxisControl
              • Functions
                • GetHoming
                • CreateParameterSet
                • GetParameterSet
                • CreateProcessingBlock
                • GetProcessingBlock
                • GetTrajectoryGenerator
                • GetTrajectoryInterpolator
                • GetParameterSets
                • GetProcessingBlocks
                • GetParameterSetNames
                • GetProcessingBlockNames
            • IAxisControlBase
              • Functions
                • GetStateMachine
                • GetCommandQueue
                • GetSignal
                • SubscribeRootError
                • GetRootError
                • GetSignals
                • GetErrors
                • GetSignalNames
                • ResetFault
            • IAxisControlGroup
              • Functions
                • GetAxisControl
                • GetAxisControls
                • GetAxisControlNames
                • PauseAxis
                • ResumeAxis
            • IBus
              • Functions
                • GetBusType
                • GetSignal
                • GetSignals
                • GetControllers
                • GetSignalNames
                • CreateController
                • CreateControllerFromFile
            • ICloseLoop
            • ICommandBase
              • Functions
                • GetState
                • GetRunException
                • GetId
            • ICommandGroup
              • Functions
                • GetSyncMode
                • CreateCommands
                • GetCommands
                • SetSyncMode
            • ICommandQueue
              • Functions
                • GetFailedCommand
                • GetStateMachine
                • CreateCommandSequence
                • CreateCommandSequence
                • GetInput
                • GetSignal
                • GetInputs
                • GetSignals
                • GetSupportedCommandTypes
                • GetSequences
                • GetInputNames
                • GetSignalNames
                • GetDepth
                • Clear
                • Continue
                • Queue
            • ICommandSequence
              • Functions
                • GetState
                • SubscribeComplete
                • GetCommands
                • GetFailedCommands
                • Reuse
                • WaitComplete
            • ICommandSequenceEventResponse
              • Functions
                • GetSequence
                • Abort
                • SetSequence
            • ICondition
              • Functions
                • Operator=
            • IController
              • Functions
                • IsBackupRunning
                • IsCompatible
                • IsConnected
                • IsRebootRequired
                • IsSimulated
                • GetActuator
                • CreateAxisControl
                • GetAxisControl
                • CreateAxisControlGroup
                • GetAxisControlGroup
                • GetBus
                • GetLatch
                • GetLogBuffer
                • CreateMatrix
                • GetMatrix
                • CreateProcessingBlock
                • GetProcessingBlock
                • GetSensor
                • GetSignal
                • GetController
                • SubscribeConnection
                • SubscribeConnectionLost
                • CreateTemplate
                • GetTemplate
                • GetUpdatable
                • GetActuators
                • GetAxisControls
                • GetAxisControlGroups
                • GetBuses
                • GetLatches
                • GetMatrices
                • GetProcessingBlocks
                • GetSensors
                • GetSignals
                • GetControllers
                • GetTemplates
                • GetUpdatables
                • GetAddress
                • GetHardwareInterfaceProductNumber
                • GetHardwareProductNumber
                • GetHardwareSerialNumber
                • SaveConfiguration
                • GetActuatorNames
                • GetAxisControlGroupNames
                • GetAxisControlNames
                • GetBusNames
                • GetControllerNames
                • GetLatchNames
                • GetMatrixNames
                • GetProcessingBlockNames
                • GetSensorNames
                • GetSignalNames
                • GetTemplateNames
                • GetUpdatableNames
                • GetId
                • CreateController
                • CreateControllerFromFile
                • LoadConfiguration
                • LoadConfiguration
                • LoadConfigurationFromFile
                • LoadConfigurationFromFile
                • Reboot
                • SaveConfigurationToFile
            • IDestroyable
              • Functions
                • Destroy
            • IDisableOperation
            • IDisableVoltage
            • IEnableOperation
            • IEvent
              • Functions
                • GetContextEnabled
                • GetSignal
                • Subscribe
                • GetSignals
                • GetSignalNames
                • Force
                • SetContextEnabled
            • IEventResponder
              • Functions
                • GetResponse
                • SubscribeResponses
                • GetResponses
                • GetResponseNames
            • IEventResponse
              • Functions
                • ContainsEvent
                • ContainsPropagatingEventResponse
                • RemoveEvent
                • RemovePropagatingEventResponse
                • GetEventCount
                • GetPropagatingEventResponseCount
                • GetSignal
                • Subscribe
                • GetSignals
                • GetEvents
                • GetPropagatingEventResponses
                • GetSignalNames
                • AddEvent
                • AddPropagatingEventResponse
                • ClearEvents
                • ClearPropagatingEventResponses
            • IEventSource
              • Functions
                • GetEvent
                • SubscribeEvents
                • GetEvents
                • GetEventNames
                • Force
            • IFilter
              • Functions
                • GetDiscretization
                • GetFilterType
                • GetInput
                • GetSignal
                • GetInputs
                • GetSignals
                • GetInputNames
                • GetSignalNames
            • IFrame
              • Functions
                • GetReferenceFrame
                • GetRotation
                • GetTranslation
                • GetSignal
                • GetSignals
                • GetSignalNames
                • SetRotation
                • SetTranslation
            • IFrameObserver
            • IFrameRotation
              • Functions
                • Operator=
            • IFrameTranslation
              • Functions
                • Operator=
            • IGeometry
              • Functions
                • GetGeometryType
                • CreateFrame
                • GetFrame
                • GetConfig
                • GetSignal
                • GetFrames
                • GetSignals
                • GetFrameNames
                • GetSignalNames
            • IGeometryConfig
              • Functions
                • Operator=
            • IGeometryMassConfig
            • IHoming
              • Functions
                • GetTimeout
                • GetMethod
                • GetStateMachine
                • GetInput
                • GetRunException
                • GetSignal
                • GetInputs
                • GetSignals
                • GetSupportedMethods
                • GetInputNames
                • GetSignalNames
                • Reset
                • SetMethod
                • SetTimeout
                • Start
            • IInput
              • Functions
                • GetSignal
                • GetSource
                • GetSignals
                • GetSignalNames
                • SetSource
            • IJog
              • Functions
                • GetConfiguration
                • SetConfiguration
            • IJoint
              • Functions
                • GetJointType
                • GetAxisControl
                • GetOutputFrame
                • GetReferenceFrame
                • GetSignal
                • GetSignals
                • GetSignalNames
                • SetReferenceFrame
            • ILatch
              • Functions
                • GetTriggerMode
                • GetTriggerType
                • GetInput
                • GetStateMachine
                • GetSignal
                • WaitTrigger
                • SubscribeTrigger
                • GetInputs
                • GetSignals
                • GetInputNames
                • GetSignalNames
                • Disable
                • Enable
                • SetTriggerMode
                • SetTriggerType
            • ILockableParameterSet
            • ILogBuffer
              • Functions
                • ReserveLogReader
                • GetCategories
                • AddMessage
                • SetCategories
            • ILogReader
              • Functions
                • GetRemainingCapacity
                • SubscribeRemainingCapacity
                • Read
                • Clear
            • IMatrix
              • Functions
                • GetInput
                • GetSignal
                • GetInputs
                • GetSignals
                • GetDimensions
                • GetInputNames
                • GetSignalNames
                • GetValues
                • SetValues
            • IMoveCommand
              • Functions
                • GetCompletionCriterion
                • SetCompletionCriterion
            • INamed
              • Functions
                • GetChild
                • GetChildren
                • GetDefaultName
                • GetFullName
                • GetName
                • GetChildNames
                • GetByDefaultName
                • GetByDefaultPath
                • GetByPath
                • SetName
            • IObject
              • Functions
                • GetType
                • GetParent
            • IoBus::IBus
              • Functions
                • GetStateMachine
                • GetTypedControllers
            • IoBus::ISubController
              • Functions
                • GetStateMachine
            • IOpenLoop
            • IParameterSet
              • Functions
                • Apply
            • IParameterSetBase
              • Functions
                • SetValues
            • IPathMove
              • Functions
                • GetComputationState
                • GetReferenceFrame
                • GetTargetFrame
                • GetComputationException
                • SubscribeComputationState
                • GetStartConditions
                • GetRemainingSegments
                • AppendSegments
                • ClearSegments
                • Precompute
                • ReplaceSegments
                • SetSegments
                • SetStartConditions
                • SetTargetFrame
                • WaitComputationState
            • IProcessingBlock
              • Functions
                • GetCalculationStart
                • GetExecutionBudget
                • GetPeriod
                • GetExecutionType
                • GetFilter
                • GetInput
                • GetSignal
                • GetUpdatable
                • GetFilters
                • GetInputs
                • GetSignals
                • GetUpdatables
                • GetFilterNames
                • GetInputNames
                • GetSignalNames
                • GetUpdatableNames
                • SetCalculationStart
                • SetExecutionBudget
                • SetExecutionType
                • SetPeriod
            • IQuickStop
            • IRelMove
              • Functions
                • GetConfiguration
                • SetConfiguration
            • IRigidBody
              • Functions
                • CreateFrame
                • GetFrame
                • CreateGeometry
                • GetGeometry
                • CreateJoint
                • GetJoint
                • GetSignal
                • GetFrames
                • GetGeometries
                • GetJoints
                • GetSignals
                • GetFrameNames
                • GetGeometryNames
                • GetJointNames
                • GetSignalNames
            • IRobot
              • Functions
                • GetCreationState
                • GetAxisControlGroup
                • CreateParameterSet
                • GetParameterSet
                • CreateRigidBody
                • GetRigidBody
                • GetSignal
                • GetParameterSets
                • GetRigidBodies
                • GetSignals
                • GetParameterSetNames
                • GetRigidBodyNames
                • GetSignalNames
                • CompleteCreation
            • ISample
              • Functions
                • GetTimestamp
                • GetStreamPosition
            • ISegment
            • ISensor
              • Functions
                • GetFilter
                • GetInput
                • GetPowerStateMachine
                • GetSignal
                • GetUpdatable
                • GetFilters
                • GetInputs
                • GetSignals
                • GetUpdatables
                • GetFilterNames
                • GetInputNames
                • GetSignalNames
                • GetUpdatableNames
            • ISetSignal
              • Functions
                • GetConfigurationDouble
                • GetConfigurationUint32
                • SetConfigurationDouble
                • SetConfigurationUint32
            • IShutdown
            • ISignal
              • Functions
                • IsWritable
                • GetLowerBound
                • GetUpperBound
                • ReadDouble
                • GetDataType
                • SubscribeMatch
                • SubscribeMatch
                • GetTranslations
                • GetDescription
                • GetTranslation
                • GetUnit
                • GetTranslationIndices
                • ReadUint32
                • SetUnit
                • WaitMatch
                • WaitMatch
                • WriteDouble
                • WriteUint32
            • ISignalCollection
              • Functions
                • ContainsSignal
                • RemoveSignal
                • GetSignalCount
                • GetSignals
                • AddSignal
                • ClearSignals
            • ISmoothStop
            • ISnapshot
              • Functions
                • GetSample
            • IStateMachine
              • Functions
                • GetSignal
                • SubscribeState
                • GetSignals
                • GetSignalNames
                • GetState
                • SetState
                • WaitState
            • ISubController
              • Functions
                • GetBusType
                • GetBusToParent
                • ApplyModel
                • ApplyModelFromFile
            • ISubscription
              • Functions
                • Unsubscribe
            • ISwitchOn
            • ISystem
              • Functions
                • GetDiscoveryInterval
                • GetExpirationTime
                • GetLogBuffer
                • SubscribeConnection
                • SubscribeConnectionLost
                • SubscribeObjectChildAdded
                • SubscribeObjectChildRemoved
                • SubscribeObjectPropertyChanged
                • GetController
                • GetControllers
                • GetControllerNames
                • GetVersion
                • CreateController
                • CreateControllerFromFile
                • CreateControllers
                • CreateControllersFromFile
                • Discover
                • SetDiscoveryInterval
                • SetExpirationTime
            • ITemplate
              • Functions
                • IsMutable
                • GetTemplateType
                • GetUpdatable
            • ITopController
              • Functions
                • GetState
                • ReserveAcquisition
                • GetWorldFrame
                • CreateRobot
                • CreateRobotFromFile
                • CreateRobotFromString
                • GetRobot
                • ReserveSnapshot
                • SubscribeAsynchronousException
                • SubscribeStateChange
                • GetKeepAliveSettings
                • GetTime
                • GetRobots
                • GetRobotNames
                • ApplyModel
                • ApplyModelFromFile
                • Run
                • SetKeepAliveSettings
                • SetTime
                • Stop
                • WaitState
            • ITrajectoryGenerator
              • Functions
                • GetSignal
                • GetSignals
                • GetSignalNames
            • ITrajectoryInterpolator
              • Functions
                • GetInput
                • GetSignal
                • GetStateMachine
                • GetInputs
                • GetSignals
                • GetInputNames
                • GetSignalNames
            • ITriggerMatchSignal
              • Functions
                • GetConfiguration
                • SetConfiguration
            • IUpdatable
              • Functions
                • SubscribeComplete
                • SubscribeProgress
                • GetPn
                • GetContents
                • GetVersion
                • GetMaxSize
                • LoadContentsFromFile
                • SaveContentsToFile
                • SetContents
                • WaitComplete
            • IWaitDuration
              • Functions
                • GetDuration
                • SetDuration
            • IWaitMatchSignal
              • Functions
                • GetConfigurationDouble
                • GetConfigurationUint32
                • SetConfigurationDouble
                • SetConfigurationUint32
          • Structs
            • EtherCat
              • EState
              • IStateMachine
              • PBus
              • PStateMachine
              • PSubController
            • IoBus
              • EState
              • IStateMachine
              • PBus
              • PStateMachine
              • PSubController
            • IsSignalTypeSupported
              • Functions
                • Test
                • Test
            • SAcquisitionTriggerOccurrence
            • SBezierCurveSegment
            • SCartesianTranslation
            • SConstantVelocity
            • SCylindricalTranslation
            • SDirectionVector
            • SDirectionVectorRotation
            • SDirectionVectorRotationSeries
            • SDoubleCondition
            • SEventOccurrence
            • SGenericMassConfig
            • SKeepAliveSettings
            • SSignalCondition
            • SSignalValue
              • Functions
                • Operator T
            • SSimulatedControllerProperties
            • SSimulatorSettings
            • SSphericalTranslation
            • STrivialCondition
            • STypeToESignalDataType
            • SUint32Condition
            • SValue
            • SVersion
            • SWaypoint
          • Typedefs
            • AcqCompleteHandler
            • AcquisitionCompleteHandler
            • AcquisitionErrorHandler
            • AcquisitionNextHandler
            • AcquisitionTriggerHandler
            • AsynchronousExceptionHandler
            • CommandSequenceCompleteHandler
            • ComputationStateHandler
            • ConnectionHandler
            • ConnectionLostHandler
            • EventOccurredHandler
            • EventResponseHandler
            • LatchTriggeredHandler
            • LogReaderRemainingCapacityHandler
            • ObjectChildAddedHandler
            • ObjectChildRemovedHandler
            • ObjectPropertyChangedHandler
            • PAbsMove
            • PAcqSink
            • PAcquisition
            • PAcquisitionTrigger
            • PActuator
            • PAlignment
            • PAlignmentStateMachine
            • PApplyParameterSet
            • PAxisControl
            • PAxisControlGroup
            • PAxisControlStateMachine
            • PBus
            • PCloseLoop
            • PCommandBase
            • PCommandGroup
            • PCommandQueue
            • PCommandQueueStateMachine
            • PCommandSequence
            • PCommandSequenceEventResponse
            • PCommandStateMachine
            • PCondition
            • PController
            • PDestroyable
            • PDisableOperation
            • PDisableVoltage
            • PEnableOperation
            • PEvent
            • PEventResponder
            • PEventResponse
            • PEventSource
            • PFilter
            • PFrame
            • PFrameObserver
            • PFrameRotation
            • PFrameTranslation
            • PGeometry
            • PGeometryConfig
            • PHoming
            • PHomingStateMachine
            • PInput
            • PJog
            • PJoint
            • PLatch
            • PLatchStateMachine
            • PLockableParameterSet
            • PLogBuffer
            • PLogReader
            • PMatrix
            • PMoveCommand
            • PNamed
            • PObject
            • POpenLoop
            • PParameterSet
            • PParameterSetBase
            • PPathMove
            • PPowerStateMachine
            • PProcessingBlock
            • PQuickStop
            • PRelMove
            • PRigidBody
            • PRobot
            • PSample
            • PSegment
            • PSensor
            • PSetSignal
            • PShutdown
            • PSignal
            • PSignalCollection
            • PSmoothStop
            • PSnapshot
            • PSubController
            • PSubscription
            • PSwitchOn
            • PSystem
            • PTemplate
            • PTopController
            • PTrajectoryGenerator
            • PTrajectoryInterpolator
            • PTrajectoryStateMachine
            • PTriggerMatchSignal
            • PUpdatable
            • PWaitDuration
            • PWaitMatchSignal
            • SignalMatchHandler
            • StateMachineStateHandler
            • TopControllerStateChangeHandler
            • UpdatableCompleteHandler
            • UpdatableProgressHandler
      • Exceptions
      • Processing blocks
        • BooleanMatch
        • Feedforward
        • GainOffset
        • GenericFeedbackControl
        • MovingStatistics
        • NtcConversion
        • OffsetGainOffset
        • PlantSecondOrderMechanical
        • PositionBasedAngle
        • PositionControlAdvanced
        • PositionControlSimple
        • PseudoRandomNoiseGenerator
        • SineGenerator
        • Sum
        • TrapeziumGenerator
        • UserDefinedSequence
        • UserSignals
        • VelocityControlAdvanced
        • VelocityControlSimple
      • XML definitions
        • Configuration
          • Types
            • Controller
            • SubController
            • NamedMutation
            • NamedReference
            • Signal
            • Updatable
            • Template
            • AxisControl
            • AxisControlGroup
            • Latch
            • TrajectoryGenerator
            • TrajectoryInterpolator
            • ParameterSet
            • ProcessingBlock
            • Filter
            • Input
            • Event
            • EventResponse
            • CommandQueue
            • Homing
            • Actuator
            • Sensor
            • Alignment
            • Matrix
            • Variant
          • Complete XML schema
        • System description
          • Types
            • System
            • Property
            • Controller
            • Bus
          • Complete XML schema
          • Complete XML example
        • Controller description
        • Persistent configuration
          • Types
            • Configuration
            • EtherCatObject
            • EtherCatSubObject
            • Index
            • DataType
          • Complete XML schema
          • XML example
      • Binary definitions
        • Persistent configuration
      • Control loop customization
        • Simulink code generation
          • Considerations
          • Block compatibility
          • PMP Simulink library
            • Common components
              • EnableSwitch
              • SettlingStateMachine
              • TimeDelay
              • TrackingErrorCalculation
            • Filters
              • GenericFilter
              • Integrator
              • PIDLowPass
            • Controller SamplePeriod
            • Event Output
            • Read Timer
            • Start Timer
            • Versioning
          • Simulink model configuration
          • Mapping to PMP objects
            • Inport Block
            • Outport Block
            • Testpoint
            • Parameter
            • Event Output
          • PMP functions
            • PmpParameter
            • PmpSignal
            • PmpBus
            • PmpUpdatable
            • PmpRunCodeGen
        • Custom C/C++ code
          • Considerations
          • Processing block interface generator
          • Processing block interface definition
            • Components
              • Description
              • ModelVersion
              • Events
              • Inputs
              • Parameters
              • Outputs
              • Updatables
            • Complete interface schema
          • C++ interface
            • Processing block methods
            • PMP object classes
              • Events
              • Inputs
              • Parameters
              • Outputs
              • Updatables
            • Callback functions
              • PMP functions
              • Macros
              • Supported runtime functions
    • Utilities
      • PMP configuration to persistent configuration converter
      • Python Integration
    • Downloads
Software version
Downloads
On Github
PMP
v:96.5.0

IObject¶

class IObject¶
virtual IObject::~IObject()¶

virtual PObject IObject::GetParent() = 0

virtual EObjectType IObject::GetType() = 0

Next
Functions
Previous
SetName
Copyright © 2024, Prodrive Technologies | Created using Sphinx and Furo theme.