Click or drag to resize

CFX.Structures Namespace

[This is preliminary documentation and is subject to change.]

Root namespace for all data structures referenced by CFX messages.
Classes
  ClassDescription
Public classBooleanMeasurement
Describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit in which the result of the measurement is a boolean (true / fales) value.
Public classCharacteristic
A singular characteristic that has been applied to a production unit
Public classComponentDesignator
Represents and identifies a particular component (instance of a part) on a production unit, or a particular aspect of a particular component, such as an individual pin of an electronic component.
Public classConsumedMaterial
Describes an event where material is consumed in the course of production.
Public classDefect
Describes a defect that was discovered on a production unit
Public classEnvironmentalCondition
Describes an environmental condition that was in place when an action was performed.
Public classFault
A dynamic structure which describes a fault that has occurred in the course of production. May be one of: Fault, SMTPlacementFault, SMTSolderPastePrintingFault, or THTInsertionFault
Public classHumidity
Public classImage
Public classInspectedUnit
Describes the results of a series of inspections performed on a single production unit.
Public classInspection
Describes a single step in a series of steps that an inspector makes (both human or automation) in the course of inspecting a production unit.
Public classInstalledComponent
Describes a particular location on a production unit where materials / parts were installed.
Public classInstalledMaterial
Describes a single lot of material that was installed on a production unit, possibly in specific locations on the production unit.
Public classMaintenanceTask
Public classMaterialCarrier
A dynamic structure which describes a device that is mounted at a process endpoint which contains source materials that are then consumed by the endpoint. An SMD Tape Feeder would be an example of a MaterialCarrier. This base MaterialCarrier structure is used to describe a generic carrier, when a more specific carrier location class is not available, such as SMDTapeFeeder, SMDTubeFeeder, and SMDTubeFeeder.
Public classMaterialCarrierLocation
Describes a specific location on an endpoint where a material carrier may be loaded. When applicable, also contains information about the currently loaded carrier, and the material package(s) loaded to that carrer.
Public classMaterialLocation
Describes a specific location on an endpoint where material may be loaded. Also includes information about the current contents of this location (if applicable).
Public classMaterialPackage
Describes a specific, single handling unit of a particular material, such as a reel of SMT parts, a bag of parts, bin of parts, etc.
Public classMaterialPackageData
An abstract base class from which dynamic material data structures derive. For example, MaterialPackageMSDData
Public classMaterialPackageDetail
Describes detailed information about a particular material package (instance of material that is tracked, stocked, and used within the factory environment.
Public classMaterialPackageMSDData
Describes addition detail for material packages containing moisture sensitive devices
Public classMaterialSetupRequirement
Describes a single, specific material setup requirement at a particular process endpoint. Includes the material / part that must be loaded at the endpoint, along with the specific location where the material must be loaded (where applicable), valid alternate part numbers that may be substituted for the primary part, and any applicable AML (Approved Manufacturer List) restrictions.
Public classMeasurement
Abstract base class for dynamic data structure which describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit
Public classNumericMeasurement
Describes a numeric (floating point) measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit
Public classNumericValue
Public classOperator
Represents an operator who performs a function
Public classPersonalizedUnit
Describes how a particular production unit has been personalized
Public classReading
Public classRecipe
Public classRegion
Describes a planar, 2 dimensional region as defined by a series of X, Y coordinates that when plotted, form the region.
Public classRequestResult
A structure which indicates whether or not a CFX request to an endpoint was successful. If not successful, information about the nature of the failure is provided.
Public classSamplingInformation
Describes the sampling strategy to be employed on a particular lot of material / units during test or inspection
Public classSegment
Public classStationSetupRequirements
Describes the material setup requirements for a particular process endpoint to perform a particular operation on one or more partiuclar products. Also includes information on where specifically the materials should be loaded (when applicable), AML (where applicable), and alternate part information (where applicable).
Public classSupportedTopic
Public classSymptom
Describes a situation where a problem is identified via one or more failed tests. A symptom does not identify the actual cause of the failure(s), only that there is a problem that needs to be investigated.
Public classTemperature
Public classTest
Describes a single test in a series of test that an tester makes (both human or automation) in the course of testing a production unit.
Public classTestedUnit
Public classTextMeasurement
Describes a measurement that was made by a human or by automated equipment in the course of inspecting or testing a production unit in which the result of the measurement is a text based value.
Public classTool
Describes a tool that is used in production
{
    "UniqueIdentifier": "UID23890430",
    "Name": "SQUEEGEE234324"
}
Public classToolHolder
Describes a location on a process endpoint where a tool may be stored.
Public classToolUsed
Public classTransportOrderHistory
Describes a single event in the history of a transport order. A transport order is a directive to move materials / WIP / production units from one location to another.
Public classUninstalledMaterial
Describes when single lot of material that is uninstalled from a production unit, possibly from specific locations on the production unit.
Public classUnitPosition
This structure contains information about a one of a set of production units that are processed simultaneously under a single transaction by an endpoint. Units may be identified in one of two ways: 1. The UnitIdentifier property represents the actual unique identifier of the production unit. 2. The UnitIdentifier property represents the unique identifier of the "carrier" or "PCB panel" AND the PositionNumber property represents the position of the unit within the carrier/panel. PositionNumber's are established as defined in the CFX Standard.
{
    "UnitIdentifier": "CARRIER5566",
    "PositionNumber": 1,
    "PositionName": "CIRCUIT1",
    "X": 0.254,
    "Y": 0.556,
    "Rotation": 0.0,
    "FlipX": false,
    "FlipY": false
}
Public classValidationResult
Enumerations
  EnumerationDescription
Public enumerationActorType
Types of Operators
Public enumerationBlockReason
Reasons why a unit is blocked
Public enumerationDataType
Types of data
Public enumerationFaultCause
Possible causes of a fault that causes a stoppage in production
Public enumerationFaultSeverity
The severity of a fault
Public enumerationInspectionMethod
Method of testing
Public enumerationLockReason
Reason for a production lock condition
Public enumerationLogImportance
Importance of an event log entry
Public enumerationMaintenanceType
Types of Maintenance
Public enumerationMaterialModifyReason
Reason why the attributes of a material package were modified
Public enumerationMaterialStatus
Status of a material package
Public enumerationMSDLevel
Levels of Moisture Sensitivity (for electronic devices)
Public enumerationMSDState
Possible states of packages of moisture sensitive devices
Public enumerationRecipeModificationReason
Reasons why a recipe was modified at an endpoint
Public enumerationResourceState
Endpoint state model
Public enumerationSamplingMethod
Describes a particular sampling methodology.
Public enumerationStatusResult
Result of an operation
Public enumerationTestMethod
Method of testing
Public enumerationTestResult
The result of a test
Public enumerationTopicSupportType
Indicates the type of support an endpoint has for a particular topic.
Public enumerationTransportOrderStatus
The status of an order to transport goods
Public enumerationValidationStatus
The result of a validation operation
Public enumerationValidationType
Types of validations
Public enumerationWorkResult
The result of an operation where work was performed on a production unit