NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 友元 | 所有成员列表
NXOpen::Routing::PortConnection类 参考

端口连接 更多...

#include <Routing_PortConnection.hxx>

类 NXOpen::Routing::PortConnection 继承关系图:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public 类型

enum  OverriddenValidity { OverriddenValidityNone , OverriddenValidityValid , OverriddenValidityInvalid }
Public 类型 继承自 NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid , AttributeTypeNull , AttributeTypeBoolean , AttributeTypeInteger ,
  AttributeTypeReal , AttributeTypeString , AttributeTypeTime , AttributeTypeReference ,
  AttributeTypeAny = 100
}
enum  DateAndTimeFormat { DateAndTimeFormatNumeric , DateAndTimeFormatTextual }

Public 成员函数

bool ArePortsAligned ()
void ForceValid (const char *reason)
void ForceValid (const NXString &reason)
double GetEngagement ()
NXOpen::Routing::PortConnection::OverriddenValidity GetOverriddenValidity ()
NXString GetOverrideReason ()
void GetPorts (NXOpen::Routing::Port **port1, NXOpen::Routing::Port **port2)
bool IsForcedValid ()
bool IsValid ()
void OverrideValidity (NXOpen::Routing::PortConnection::OverriddenValidity overriddenValidity)
void RemoveForcedValidity ()
void SetEngagement (double engagement)
void SetOverrideReason (const char *reason)
void SetOverrideReason (const NXString &reason)
void SetPorts (NXOpen::Routing::Port *port1, NXOpen::Routing::Port *port2)
Public 成员函数 继承自 NXOpen::NXObject
NXOpen::AttributeIterator * CreateAttributeIterator ()
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
virtual NXOpen::INXObject * FindObject (const char *journalIdentifier)
virtual NXOpen::INXObject * FindObject (const NXString &journalIdentifier)
bool GetBooleanUserAttribute (const char *title, int index)
bool GetBooleanUserAttribute (const NXString &title, int index)
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
int GetIntegerAttribute (const char *title)
int GetIntegerUserAttribute (const char *title, int index)
int GetIntegerUserAttribute (const NXString &title, int index)
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 获取指定对象的PDM参考属性值。 用户需提供属性标题，将返回UI显示的属性值。
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 获取指定对象的PDM参考属性值。 用户需提供属性标题，将返回UI显示的属性值。
double GetRealAttribute (const char *title)
double GetRealUserAttribute (const char *title, int index)
double GetRealUserAttribute (const NXString &title, int index)
NXString GetReferenceAttribute (const char *title)
NXString GetStringAttribute (const char *title)
NXString GetStringUserAttribute (const char *title, int index)
NXString GetStringUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetTimeAttribute(NXOpen NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
NXString GetTimeUserAttribute (const char *title, int index)
NXString GetTimeUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX11.0.0. Use GetUserAttribute instead.") std std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes ()
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes (bool includeUnset)
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes (NXOpen::AttributeIterator *iterator)
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
virtual bool IsOccurrence ()
virtual NXString JournalIdentifier ()
virtual NXString Name ()
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") double GetRealAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") int GetIntegerAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetReferenceAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetStringAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
virtual NXOpen::Assemblies::Component * OwningComponent ()
virtual NXOpen::BasePart * OwningPart ()
virtual void Print ()
virtual NXOpen::INXObject * Prototype ()
void SetAttribute (const char *title)
void SetAttribute (const char *title, const char *value)
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetAttribute (const char *title, double value)
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
void SetAttribute (const char *title, int value)
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
void SetAttribute (const char *title, NXOpen::Update::Option option)
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
virtual void SetName (const char *name)
virtual void SetName (const NXString &name)
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 设置对象的PDM参考属性值。 用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。 别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。
创建于NX12.0.0。

许可要求：无
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 设置对象的PDM参考属性值。 用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。 别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。
创建于NX12.0.0。

许可要求：无
void SetReferenceAttribute (const char *title, const char *value)
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetTimeAttribute (const char *title, const char *value)
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _PortConnectionBuilder

额外继承的成员函数

Public 属性 继承自 NXOpen::NXObject
NXOpen::Update::Option option
const NXString NXOpen::Update::Option option
double NXOpen::Update::Option option
int NXOpen::Update::Option option
const NXString & value
double value
int value

详细描述

端口连接

布线PortConnection对象由布线模块在放置零件时用于定位端口。
要创建此类的新实例，请使用 NXOpen::Routing::PortConnectionCollection::CreatePortConnection

于NX4.0.0版本创建。

成员枚举类型说明

◆ OverriddenValidity

enum NXOpen::Routing::PortConnection::OverriddenValidity

被覆盖的端口连接有效性

枚举值
OverriddenValidityNone 

端口连接有效性未被覆盖

OverriddenValidityValid 

端口连接有效性被覆盖为有效

OverriddenValidityInvalid 

端口连接有效性被覆盖为无效

成员函数说明

◆ ArePortsAligned()

bool NXOpen::Routing::PortConnection::ArePortsAligned ( )

判断端口连接中的端口是否对齐正确。将同时评估方向和旋转。

返回
当前连接的有效性
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ ForceValid() [1/2]

void NXOpen::Routing::PortConnection::ForceValid ( const char * reason)

强制连接为有效状态，无论端口对齐情况或被覆盖的有效性值如何。 系统将自动记录用户登录名、日期和时间，以及给定的原因。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
reason强制此连接为有效的原因。

◆ ForceValid() [2/2]

void NXOpen::Routing::PortConnection::ForceValid ( const NXString & reason)

强制连接为有效状态，无论端口对齐情况或被覆盖的有效性值如何。 系统将自动记录用户登录名、日期和时间，以及给定的原因。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
reason强制此连接为有效的原因。

◆ GetEngagement()

double NXOpen::Routing::PortConnection::GetEngagement ( )

获取端口连接对象所连接的两个端口之间的啮合距离。

返回
端口连接对象所连接的两个端口之间的啮合距离
于NX4.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ GetOverriddenValidity()

NXOpen::Routing::PortConnection::OverriddenValidity NXOpen::Routing::PortConnection::GetOverriddenValidity ( )

获取端口连接的被覆盖有效性值。

返回
被覆盖的有效性值
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ GetOverrideReason()

NXString NXOpen::Routing::PortConnection::GetOverrideReason ( )

获取端口连接有效性被覆盖的原因。

返回
此连接有效性被覆盖的原因
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ GetPorts()

void NXOpen::Routing::PortConnection::GetPorts ( NXOpen::Routing::Port ** port1,
NXOpen::Routing::Port ** port2 )

获取端口连接对象所连接的两个端口。
于NX4.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
port1端口连接对象所连接的第一个端口
port2端口连接对象所连接的第二个端口

◆ IsForcedValid()

bool NXOpen::Routing::PortConnection::IsForcedValid ( )

判断连接是否被强制为有效。

返回
当前连接的强制有效状态
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ IsValid()

bool NXOpen::Routing::PortConnection::IsValid ( )

判断连接是否有效。有效性最初由端口的对齐情况决定，但可通过OverrideValidity或ForceValid方法覆盖。

返回
当前连接的有效性
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ OverrideValidity()

void NXOpen::Routing::PortConnection::OverrideValidity ( NXOpen::Routing::PortConnection::OverriddenValidity overriddenValidity)

覆盖端口连接的有效性。默认情况下，有效性由所连接端口的对齐情况决定。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
overriddenValidity被覆盖的有效性值。

◆ RemoveForcedValidity()

void NXOpen::Routing::PortConnection::RemoveForcedValidity ( )

移除连接的强制有效设置。有效性将根据端口对齐情况或被覆盖的有效性设置重新确定。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

◆ SetEngagement()

void NXOpen::Routing::PortConnection::SetEngagement ( double engagement)

设置端口连接对象所连接的两个端口之间的啮合距离。
于NX4.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
engagement要设置的端口连接对象所连接的两个端口之间的啮合距离

◆ SetOverrideReason() [1/2]

void NXOpen::Routing::PortConnection::SetOverrideReason ( const char * reason)

设置端口连接有效性被覆盖的原因。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
reason此连接有效性被覆盖的原因。

◆ SetOverrideReason() [2/2]

void NXOpen::Routing::PortConnection::SetOverrideReason ( const NXString & reason)

设置端口连接有效性被覆盖的原因。
于NX8.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
reason此连接有效性被覆盖的原因。

◆ SetPorts()

void NXOpen::Routing::PortConnection::SetPorts ( NXOpen::Routing::Port * port1,
NXOpen::Routing::Port * port2 )

设置端口连接对象所连接的两个端口之间的关联。
于NX4.0.0版本创建。

许可证要求: routing_base ("Routing Basic")

参数
port1要通过端口连接对象连接的第一个端口
port2要通过端口连接对象连接的第二个端口