Info

File

src/api/model/general.ts

Description

Class

Extends

Base

Index

Properties

Public cncNodeIndex
Public cncPaths
Public cncType
Public naxis
Public nchannel
Public nspindle
Public simuspeed

Methods

Public Async getCncId
Public getCNCMessageSnapshot
Public getCncPaths
Public getCncType
Public Async getCncVersion
Public getErrorInfo
Public getErrorSnapshot
Public getKernelMessage
Public getKernelMessageSnapshot
Public getPLCMessageSnapshot
Public getSwOptions
Public isFCASAllowed
Public popSyntaxCheckErrors

Constructor

constructor(generalRaw: any, cncKernelType: enums.CncKernelType)

Parameters :

Name	Type	Optional
generalRaw	`any`	No
cncKernelType	`enums.CncKernelType`	No

Properties

Public cncNodeIndex

Type : number

Default value : 0

Decorators :


                            @Listenable()

Public cncPaths

Type : any

Default value : {}

Configured paths of current cnc

Public cncType

Type : string

Default value : ""

Decorators :


                            @Listenable()

cncType.

Public naxis

Type : Variable

Default value : <Variable>{}

Decorators :


                            @Listenable()

naxis. total axes number with empty positions of the yielded axes

Public nchannel

Type : Variable

Default value : <Variable>{}

Decorators :


                            @Listenable()

nchannel. number of channels

Public nspindle

Type : Variable

Default value : <Variable>{}

Decorators :


                            @Listenable()

nspindle. number of spindles

Public simuspeed

Type : Variable

Default value : <Variable>{}

Decorators :


                            @Listenable()

simuspeed. Percentage of simulation speed (between 0% and 100%).

Methods

Public Async getCncId

getCncId()

Get cnc identification

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getCNCMessageSnapshot

getCNCMessageSnapshot()

Gets the current cnc message list

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getCncPaths

getCncPaths()

Method that returns all configured cnc paths.

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getCncType

getCncType()

Get cnc type

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public Async getCncVersion

getCncVersion()

Get cnc version

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getErrorInfo

getErrorInfo(cncKernelType: number, errorPosition: number, language: string)

get error info It calls to CommHmiNodeServer to call appropiate REST API route.

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Parameters :

Name	Type	Optional	Description
cncKernelType	`number`	No	real/simulation
errorPosition	`number`	No	number of the error which info must be retrieved
language	`string`	No	language in which the info must be retrieved

Returns : Promise<interfaces.ServiceResponse>

Public getErrorSnapshot

getErrorSnapshot()

Gets the current error/warning list

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getKernelMessage

getKernelMessage(messageID: number, language: string)

get kernel message text It calls to CommHmiNodeServer to call appropiate REST API route.

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Parameters :

Name	Type	Optional	Description
messageID	`number`	No	ID of the message whose text is to be retrieved
language	`string`	No	language in which the text must be retrieved

Returns : Promise<interfaces.ServiceResponse>

Public getKernelMessageSnapshot

getKernelMessageSnapshot()

Gets the current kernel message list

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getPLCMessageSnapshot

getPLCMessageSnapshot()

Gets the current PLC message list

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public getSwOptions

getSwOptions()

Get sw options

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public isFCASAllowed

isFCASAllowed()

Method that returns if FCAS is allowed or not.

Returns a promise. This promise is fulfilled with reply object ServiceResponse or is rejected with CncServiceOperationException when something goes wrong.

return object will contain the returnCode, if value is 0 everything went well, if not data will have the explanation of the error.

Returns : Promise<interfaces.ServiceResponse>

Public popSyntaxCheckErrors

popSyntaxCheckErrors(channel: number, language: string)

Parameters :

Name	Type	Optional
channel	`number`	No
language	`string`	No

Returns : Promise<interfaces.ServiceResponse>

Accessors

cncVersion

getcncVersion()

Returns cnc current version

Returns : interfaces.CncVersion

cncId

getcncId()

Returns cnc current identification

Returns : interfaces.CncIdentification

cncSwOptions

getcncSwOptions()

Returns cnc software options

Returns : interfaces.SwOptions

File

Description

Extends

Index

Properties

Methods

Accessors

Constructor

Properties

Methods

Accessors

results matching ""

No results matching ""