pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::IArticleEntity Class Reference

Article interface for entities. More...

Public Member Functions

IArticleEntityInfoGetInformation ()
 Receives additional article information. More...
 
bool IsUpToDate ()
 Returns true if the article is based on the currently installed product data (OFML). More...
 
ReadOnlyCollection< String^ >^ GetChildArticles ()
 Receives a list of child article ids. More...
 

Properties

String^  Id [get]
 The unqiue id of the entity. More...
 
ArticleEntityType Type [get]
 The article type More...
 
ArticleGeometryMode GeometryMode [get]
 Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning. More...
 

Detailed Description

Article interface for entities.

Member Function Documentation

ReadOnlyCollection<String^> ^ X3g::Plugin::IArticleEntity::GetChildArticles ( )

Receives a list of child article ids.

IArticleEntityInfo ^ X3g::Plugin::IArticleEntity::GetInformation ( )

Receives additional article information.

bool X3g::Plugin::IArticleEntity::IsUpToDate ( )

Returns true if the article is based on the currently installed product data (OFML).

Otherwise it is unknown if the article is up-to-date or not.

Property Documentation

ArticleGeometryMode X3g::Plugin::IArticleEntity::GeometryMode
get

Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning.

String^ X3g::Plugin::IArticleEntity::Id
get

The unqiue id of the entity.

Relates to DbEntity::Id; The DbEntity returned by DbEntity::FromId() for this id can be cast to DbBlockReference.

ArticleEntityType X3g::Plugin::IArticleEntity::Type
get

The article type