NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Formboard::UpdateDiscrepancy Class Reference

Defines a discrepancy object which contains information about a specific difference between the formboard drawing and the 3D harness model. More...

Inheritance diagram for NXOpen::Formboard::UpdateDiscrepancy:
NXOpen::TransientObject

Public Types

enum  ObjectType {
  ObjectTypeUnknown, ObjectTypeRcp, ObjectTypeSegment, ObjectTypeClip,
  ObjectTypeComponent, ObjectTypeHarness, ObjectTypeWire, ObjectTypeCable,
  ObjectTypeShield, ObjectTypeConnector, ObjectTypeDevice, ObjectTypeOverstock,
  ObjectTypeFillerstock, ObjectTypeFittingOverstock
}
 Specifies the type of objects involved in the discrepancy. More...
 
enum  Type { TypeUnknown, TypeMissing, TypeExtra, TypeModified }
 The general type of the discrepancy. More...
 

Public Member Functions

NXString Description ()
 Returns the description string of the discrepancy. More...
 
NXOpen::Formboard::UpdateDiscrepancy::ObjectType DiscrepancyObjectType ()
 Returns the type of object referenced by the discrepancy. More...
 
NXOpen::Formboard::UpdateDiscrepancy::Type DiscrepancyType ()
 Returns the general type of the discrepancy. More...
 
NXOpen::NXObjectFormboardObject ()
 Returns the object in the 2D formboard referenced by the discrepancy. More...
 
NXOpen::NXObjectHarnessObject ()
 Returns the object in the 3D harness referenced by the discrepancy. More...
 
virtual ~UpdateDiscrepancy ()
 Frees the memory associated with this object. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Defines a discrepancy object which contains information about a specific difference between the formboard drawing and the 3D harness model.


Created in NX7.5.0.

Member Enumeration Documentation

Specifies the type of objects involved in the discrepancy.

Enumerator
ObjectTypeUnknown 

Unknown type.

ObjectTypeRcp 

Routing Control Point.

ObjectTypeSegment 

Routing Segment.

ObjectTypeClip 

A component not assigned as a electrical connector.

ObjectTypeComponent 

A component assigned as a electrical connector or device.

ObjectTypeHarness 

Harness.

ObjectTypeWire 

Wire connection.

ObjectTypeCable 

Cable connection.

ObjectTypeShield 

Shield connection.

ObjectTypeConnector 

ConnectorDevice object which has a type of connector.

ObjectTypeDevice 

ConnectorDevice object which has a type of device.

ObjectTypeOverstock 

Overstock.

ObjectTypeFillerstock 

Filler stock.

ObjectTypeFittingOverstock 

Overstock applied to fittings.

The general type of the discrepancy.

Enumerator
TypeUnknown 

Unknown type, not valid.

TypeMissing 

Object exits in the 3D harness but is missing from the formboard.

TypeExtra 

Object is in the formboard but not in the 3D harness.

TypeModified 

Object exists in both 3D and the formboard but is modified in some way.

Constructor & Destructor Documentation

virtual NXOpen::Formboard::UpdateDiscrepancy::~UpdateDiscrepancy ( )
virtual

Frees the memory associated with this object.


Created in NX7.5.0.

License requirements : None

Member Function Documentation

NXString NXOpen::Formboard::UpdateDiscrepancy::Description ( )

Returns the description string of the discrepancy.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::UpdateDiscrepancy::ObjectType NXOpen::Formboard::UpdateDiscrepancy::DiscrepancyObjectType ( )

Returns the type of object referenced by the discrepancy.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::UpdateDiscrepancy::Type NXOpen::Formboard::UpdateDiscrepancy::DiscrepancyType ( )

Returns the general type of the discrepancy.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::NXObject* NXOpen::Formboard::UpdateDiscrepancy::FormboardObject ( )

Returns the object in the 2D formboard referenced by the discrepancy.

This may be NULL depending on the type of the discrepancy.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::NXObject* NXOpen::Formboard::UpdateDiscrepancy::HarnessObject ( )

Returns the object in the 3D harness referenced by the discrepancy.

This may be NULL depending on the type of the discrepancy.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.