命名空间Lmi3d.GoSDK
GoSensor类
定义:public class GoSensor : KObject
描述:代表一个Gocator传感器
公共成员字段DefaultJob
定义:public string DefaultJob { get; set; }
描述:获取或设置启动时被加载的默认job文件的文件名,在固件版本4.0.10.27中被引入
KApiLib.Construct();
GoSdkLib.Construct();
GoSystem GocatorSystem = new GoSystem();
GoSensor GocatorSensor = GocatorSystem.FindSensorByIpAddress(KIpAddress.Parse("192.168.1.10"));
Console.WriteLine("sensor model:" + GocatorSensor.ModelNumber );
GocatorSensor.Connect();
Console.WriteLine("Default job file name:"+GocatorSensor.DefaultJob);
GocatorSensor.DefaultJob = "1.job";
Console.WriteLine("Default job file name:"+GocatorSensor.DefaultJob);
Console.ReadLine();
GocatorSensor = null;
GocatorSystem = null;
运行结果:
公共成员字段AccelerationIpAddress
定义:public KIpAddress AccelerationIpAddress { get; }
描述:当传感器加速时返回传感器的物理IP地址。固件5.2.18.3中引入
公共成员字段AccelerationOpMode
定义:public GoDiscoveryOpMode AccelerationOpMode { get; }
描述:返回传感器的工作模式。加速应用程序可使用此选项确定传感器是虚拟传感器、独立传感器还是加速传感器模式。固件5.2.18.3中引入
公共成员字段AccelerationPortInfo
定义:public GoPortInfo AccelerationPortInfo { get; }
描述:返回加速传感器使用的端口号,包括web端口。可由加速应用程序使用,以获取加速传感器使用的端口。固件5.2.18.3中引入
公共成员字段AccelerationState
定义:public GoSensorAccelState AccelerationState { get; }
描述:返回传感器的加速度状态。加速应用程序可以使用该状态来确定传感器是否可用于加速,或者是否已被主机加速。固件5.2.18.3中引入
公共成员字段AlignmentReference
定义:public GoAlignmentRef AlignmentReference { get; set; }
描述:获取传感器的校准参考。固件4.0.10.27中引入
公共成员字段AlignmentState
定义:public GoAlignmentState AlignmentState { get; }
描述:获取传感器的校准状态。固件4.0.10.27中引入
公共成员字段AutoStart
定义:public bool AutoStart { get; set; }
描述:获取和设置传感器当前使用的自动启动启用状态。固件4.0.10.27中引入,如果启用了自动启动,则为kTrue,否则为kFALSE。
公共成员字段BuddyId
定义:public uint BuddyId { get; }
描述:获取传感器的设备ID。固件4.0.10.27中引入
公共成员字段ControlPort
定义:public uint ControlPort { get; set; }
描述:返回控制端口编号,固件4.8.2.76中引入
公共成员字段DataPort
定义:public uint DataPort { get; set; }
描述:返回数据端口编号,固件4.8.2.76中引入
公共成员字段Family
定义:public GoFamily Family { get; }
描述:返回表示当前传感器系列的枚举数值。固件4.0.10.27中引入
公共成员字段FileCount
定义:public int FileCount { get; }
描述:获取连接的传感器中可用的文件数。这包括可能无法通过web界面看到的文件。固件4.0.10.27中引入
公共成员字段FirmwareVersion
定义:public KVersion FirmwareVersion { get; }
描述:得到传感器的固件版本,固件4.0.10.27中引入
公共成员字段HealthPort
定义:public uint HealthPort { get; set; }
描述:返回状态端口编号,固件4.8.2.76中引入
公共成员字段Id
定义:public uint Id { get; }
描述:获取与此传感器关联的设备标识符。固件4.0.10.27中引入
公共成员字段InputSource
定义:public GoInputSource InputSource { get; set; }
描述:得到传感器当前使用的输入源,固件4.0.10.27中引入
公共成员字段Output
定义:public GoOutput Output { get; }
描述:获取用于输出配置的输出模块。固件4.0.10.27中引入
公共成员字段PartMatchModelCount
定义:public long PartMatchModelCount { get; }
描述:返回当前加载作业中存在的零件匹配模型数。固件4.2.4.7中引入
公共成员字段PartNumber
定义:public string PartNumber { get; }
描述:获取与此传感器关联的零件号。固件5.3.17.23中引入
公共成员字段ProtocolVersion
定义:public KVersion ProtocolVersion { get; }
描述:获取此传感器的协议版本。固件4.0.10.27中引入
公共成员字段QuickEdit
定义:public bool QuickEdit { get; set; }
描述:获取此传感器的快速编辑状态。固件4.7.11.5中引入,如果快速编辑使能返回true,否则返回false
公共成员字段RecordingEnabled
定义:public bool RecordingEnabled { get; set; }
描述:获取此传感器的记录状态。固件4.0.10.27中引入,如果记录使能返回true,否则返回false
公共成员字段RemoteInfoCount
定义:public long RemoteInfoCount { get; }
描述:获取由传感器保存的远端传感器信息的数量。固件4.0.10.27中引入。
公共成员字段Replay
定义:public GoReplay Replay { get; }
描述:获取用于回放配置的回放模块。固件4.5.3.57中引入
公共成员字段Role
定义:public GoRole Role { get; }
描述:获取传感器在系统中的当前角色。固件4.0.10.27中引入。
公共成员字段RuntimeVariableCount
定义:public long RuntimeVariableCount { get; }
描述:返回设备上可用的运行时变量数。固件4.5.3.57中引入
公共成员字段ScanMode
定义:public GoMode ScanMode { get; }
描述:获得传感器的扫描模式。固件4.0.10.27中引入。
公共成员字段Setup
定义:public GoSetup Setup { get; }
描述:获取与传感器关联的GoSetup实例。固件4.0.10.27中引入。
公共成员字段State
定义:public GoState State { get; }
描述:报告当前的传感器状态。固件4.0.10.27中引入。
公共成员字段States
定义:public GoStates States { get; }
描述:报告当前的传感器状态。固件4.0.10.27中引入。
公共成员字段Tools
定义:public GoTools Tools { get; }
描述:获取传感器的工具模块,用于测量配置。固件4.0.10.27中引入。
公共成员字段Transform
定义:public GoTransform Transform { get; }
描述:获取用于转换配置的转换模块。固件4.0.10.27中引入。
公共成员字段UpgradePort
定义:public uint UpgradePort { get; set; }
描述:返回和设置升级端口。固件4.8.2.76中引入。
公共成员字段User
定义:public GoUser User { get; }
描述:报告与当前用户关联的用户帐户。固件4.0.10.27中引入。
公共成员字段UserStorageFree
定义:public ulong UserStorageFree { get; }
描述:获取用户文件剩余的可用存储空间。
公共成员字段UserStorageUsed
定义:public ulong UserStorageUsed { get; }
描述:获取用户文件使用的存储空间。
公共成员方法AddBuddy
定义:public void AddBuddy(GoSensor buddy);
描述:分配一个从传感器。此函数是异步的,同步版本可以使用GoSensor类的addBuddyBlock()方法。注意:提供的从传感器必须已连接。固件4.0.10.27中引入。buddy被指定为从传感器。
公共成员方法AddBuddyBlocking
定义:public void AddBuddyBlocking(GoSensor buddy);
描述:同步分配一个从传感器。注意:提供的从传感器必须已连接。在固件版本4.8.1.65中被引入,buddy被指定为从传感器。
公共成员方法Address
定义:public GoAddressInfo Address();
描述:检索传感器的网络地址设置。在固件版本4.0.10.27中被引入
公共成员方法Align
定义:public void Align();
描述:使用配置的校准类型和目标执行校准。注意:此操作将导致传感器在校准期间启动。可通过GoSensor类Stop方法取消。此功能的运行状态与实际校准结果不一致。为了检索校准结果,必须在调用此函数之前启用数据通道,接收校准数据消息,然后检查其状态。警告此操作可能(取决于校准参考)写入闪存。查看用户手册以了解其含义。在固件版本4.0.10.27中被引入,备注:调用此函数将导致写入闪存操作。如果过程因断电或其他因素而中断,传感器可能会进入救援模式。
公共成员方法Backup
定义:public void Backup(string destPath);
描述:创建传感器文件的备份,并将备份下载到指定位置。在固件版本4.0.10.27中被引入,destPath保存备份文件的本地文件系统路径。
公共成员方法BuddiesCount
定义:public ulong BuddiesCount();
描述:得到系统中从设备的数量,在固件版本4.6.4.66中被引入
公共成员方法Cancel
定义:public void Cancel();
描述:中止正在进行的传感器通信。此方法异步中止正在进行的通信;下次任何I/O操作阻塞较长时间时,通信将被终止。此方法是线程安全的。要恢复通信,请调用GoSensor类的Refresh()方法 或GoSensor类的Connect()方法,在固件版本4.0.10.27中被引入
公共成员方法CanStart
定义:public bool CanStart();
描述:检查传感器是否已准备好启动,是否已连接所有指定的从设备。在固件版本5.2.18.3中被引入
公共成员方法ChangePassword
定义:public void ChangePassword(GoUser user, string password);
描述:更改与指定用户帐户关联的密码。警告此操作写入闪存。查看用户手册以了解其含义。在固件版本4.0.10.27中被引入,备注:调用此函数将导致写入闪存操作。如果过程因断电或其他因素而中断,传感器可能会进入救援模式。
公共成员方法ClearAlignment
定义:public void ClearAlignment();
描述:清除当前传感器校准。警告此操作写入闪存。查看用户手册以了解其含义。在固件版本4.1.3.106中被引入,备注:调用此函数将导致写入闪存操作。如果过程因断电或其他因素而中断,传感器可能会进入救援模式。
公共成员方法ClearLog
定义:public void ClearLog();
描述:清除log文件(_live.log)。在固件版本4.0.10.27中被引入
公共成员方法ClearMeasurementStats
定义:public void ClearMeasurementStats();
描述:重置运行状况通道报告的测量统计信息。在固件版本4.0.10.27中被引入
公共成员方法ClearReplayData
定义:public void ClearReplayData();
描述:清空回放缓存。在固件版本4.0.10.27中被引入
公共成员方法Connect
定义:public void Connect();
描述:创建一个到传感器的连接,在固件版本4.0.10.27中被引入
公共成员方法ConnectAndLogIn
定义:public void ConnectAndLogIn(GoUser user, string password);
描述:使用指定的用户名和密码连接并登录传感器。启用安全保护后,需要登录才能以编程方式控制传感器。如果启用安全保护,匿名连接方法会失败,应使用以上连接方法替代,在固件版本5.2.18.3中被引入,user用户账号,password用户密码
公共成员方法CopyFile
定义:public void CopyFile(string sourceName, string destName);
描述:在被连接的传感器中copy一个文件,如果目标文件名是_live.job,传感器配置中使用的job文件被改变(也就是说,进行了一个job选择操作),要进行一个job的加载/切换,传感器在job加载/切换之前首先要停止。在job加载/切换之后,传感器保持停止状态,以匹配从GUI加载/切换一个job文件的行为。警告!这个操作会写flash存储器,查阅用户手册以获取含义。注意,如果执行了一个job的加载/切换,这个API会使传感器停止,用户必须再次明确的启动传感器,在固件版本4.0.10.27中被引入。参数sourceName为被copy的源文件名,参数destName为目标文件名(最大63个字符)。注意,如果目标文件名不是_live.job,调用这个方法能够导致写flash存储器操作,如果这个过程因为掉电或者其他原因被中断,传感器可能进入故障模式。
公共成员方法DeleteFile
定义:public void DeleteFile(string name);
描述:在被连接的传感器中删除一个文件,在固件版本4.0.10.27中被引入,参数name为被删除的文件的名字。备注,调用这个方法会造成写入flash存储器操作,如果这个过程因为掉电或者其他原因被中断,传感器可能进入故障模式。
公共成员方法DirectoryFileCount
定义:public long DirectoryFileCount(string extensionFilter, string path, bool isRecursive);
描述:返回指定路径中包含的文件数,方法可通过参数输入一个可选的扩展名筛选器,在固件版本4.1.3.106中被引入,extensionFilter要应用的可选扩展筛选器。发送空字符串“”以不应用筛选器。path要检索其文件计数的文件系统路径。isRecursive kTRUE将文件包含在路径的子文件夹中,kFALSE将仅统计当前路径中的文件。返回应用了可选扩展名筛选器的指定路径中包含的文件数。
公共成员方法Disconnect
定义:public void Disconnect();
描述:断开与传感器的连接。当状态被GoSensor类的LockState()方法锁定时,不要调用此函数。在固件版本4.0.10.27中被引入
公共成员方法DownloadFile
定义:public void DownloadFile(string sourceName, string destPath);
描述:从连接的传感器下载文件。以下是表示此操作中使用的常用文件的宏列表:
GO_SENSOR_LIVE_JOB-表示“_LIVE.JOB”。
GO_SENSOR_LIVE_REPLAY-表示回放文件“_LIVE.rec”。
还可以指定已保存作业的文件名。在固件版本4.0.10.27中被引入,sourceName被下载的源文件的名称,destPath要下载的文件的目标文件系统路径
公共成员方法EmitAnalog
定义:public void EmitAnalog(ushort index, long target, int value);
描述:安排一个模拟输出。此方法要求将输出配置为在软件控制时触发。注:不可能安排连续输出。如果尝试,操作将相应失败。在固件版本4.0.10.27中被引入,index模拟输出索引,target时间或位置目标(us或mm),如果GoAnalog类的ScheduleEnabled属性为false,则忽略。value计划输出(uA)的值。
公共成员方法EmitDigital
定义:public void EmitDigital(ushort index, long target, byte value);
描述:安排数字输出。此方法要求将输出配置为在软件控制时触发。在固件版本4.0.10.27中被引入,index数字输出索引,target时间或位置目标(us或mm),如果GoDigital类的ScheduleEnabled属性为false或者GoDigital类的SignalType属性是pulsed.,则忽略。value计划输出的值(0-低或1-高)。如果输出GoDigital类的SignalType属性是pulsed,则忽略。
公共成员方法EnableData
定义:public void EnableData(bool enable);
描述:启用或禁用传感器的数据通道。在使用GoSensor类的EnableData函数后,SDK应用程序负责处理保存数据连接上从传感器接收的数据的GoDataSet对象。在固件版本4.0.10.27中被引入,enable kTRUE使能,或者kFALSE禁止
公共成员方法Start
定义:public void Start();
描述:启动传感器,在固件版本4.0.10.27中被引入
公共成员方法Stop
定义:public void Stop();
描述:停止传感器,在固件版本4.0.10.27中被引入
GoTransform类
定义:public class GoTransform : KObject
描述:表示传感器转换
公共成员字段EncoderResolution
定义:public double EncoderResolution { get; set; }
描述:获取或设置编码器分辨率。单位为mm/tick。警告设置操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。
公共成员字段Speed
定义:public double Speed { get; set; }
描述:获取或设置运行速度。单位为mm/sec。警告设置操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。
公共成员方法GetX
定义:public double GetX(GoRole role);
描述:获取转换的X分量。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法GetXAngle
定义:public double GetXAngle(GoRole role);
描述:获取转换的X角度。单位为度。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法GetY
定义:public double GetY(GoRole role);
描述:获取转换的Y分量。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法GetYAngle
定义:public double GetYAngle(GoRole role);
描述:获取转换的Y角度。单位为度。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法GetZ
定义:public double GetZ(GoRole role);
描述:获取转换的Z分量。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法GetZAngle
定义:public double GetZAngle(GoRole role);
描述:获取转换的Z角度。单位为度。固件4.0.10.27中引入。确定要从GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)设备中检索值。有关更多详细信息,请参见GoRole。
公共成员方法SetX
定义:public void SetX(GoRole role, double offset);
描述:设置转换的X分量。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的X分量
公共成员方法SetY
定义:public void SetY(GoRole role, double offset);
描述:设置转换的Y分量。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的Y分量
公共成员方法SetZ
定义:public void SetZ(GoRole role, double offset);
描述:设置转换的Z分量。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的Z分量
公共成员方法SetXAngle
定义:public void SetXAngle(GoRole role, double offset);
描述:设置转换的X角度。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的X角度,单位度
公共成员方法SetYAngle
定义:public void SetYAngle(GoRole role, double offset);
描述:设置转换的Y角度。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的Y角度,单位度
公共成员方法SetZAngle
定义:public void SetZAngle(GoRole role, double offset);
描述:设置转换的Z角度。警告此操作写入闪存。查看用户手册以了解其含义。固件4.0.10.27中引入。role确定要对哪个设备应用更改。使用GO_ROLE_MAIN或GO_ROLE_BUDDYIDX(BUDDYIDX)。有关更多详细信息,请参见GoRole。offset要设置的转换的Z角度,单位度
命名空间Lmi3d.GoSdk.Tools
描述:与工具相关的配置
GoTools类
定义:public class GoTools : KObject
描述:代表一个工具集合
公共成员字段ToolCount
定义:public long ToolCount { get; }
描述:返回当前工具的数量。固件4.0.10.27中引入。
公共成员字段ToolOptionCount
定义:public long ToolOptionCount { get; }
描述:返回当前配置可用的工具选项数。固件4.3.3.124中引入
公共成员方法AddMeasurementByName
定义:public GoMeasurement AddMeasurementByName(GoTool tool, string type, string name);
描述:通过表示类型的字符串向工具添加测量。固件4.3.3.124中引入,tool准备添加测量的工具,type表示为字符串的要添加的测量类型,name新测量分配的名称,返回新添加的测量
公共成员方法AddToolByName
定义:public GoTool AddToolByName(string optionName);
描述:通过名称添加一个工具。固件4.3.3.124中引入,optionName准备添加的工具的名称
公共成员方法AssignMeasurementId
定义:public void AssignMeasurementId(GoMeasurement measurement);
描述:自动更新指定的测量,以便在GoTools对象中包含的工具集中使用有效ID。固件4.0.10.27中引入,measurement准备更新的GoMeasurement对象
公共成员方法ClearTools
定义:public void ClearTools();
描述:给定的GoTools实例删除所有工具,固件4.0.10.27中引入
公共成员方法FindMeasurementById
定义:public GoMeasurement FindMeasurementById(uint id);
描述:如果指定的ID有效,则返回已启用的测量,固件4.0.10.27中引入,id要搜索的测量ID,如果启用的测量的ID被发现,返回一个GoMeasurement对象
公共成员方法GetTool
定义:public GoTool GetTool(long index);
描述:通过给定的索引返回一个工具,固件4.0.10.27中引入,index用于检索工具的索引
公共成员方法GetToolOption
定义:public GoToolOption GetToolOption(long index);
描述:通过给定的索引检索工具选项,固件4.3.3.124中引入,index要访问的选项列表的索引,返回与给定索引关联的工具选项
公共成员方法MoveTool
定义:public void MoveTool(long index, long newIndex);
描述:移动一个工具到数组中的另一个位置,固件4.7.9.77中引入,index要移动的工具的索引,newIndex工具将移动到的新索引
公共成员方法RemoveTool
定义:public void RemoveTool(long index);
描述:通过给定的索引删除一个工具,固件4.0.10.27中引入,index要删除的工具的索引