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

Ofml Object. More...

Public Member Functions

bool IsExisting ()
 Returns true if this object still exists. More...
 
bool IsSelectable ()
 Returns true if this object is selectable. More...
 
bool IsArticle ()
 Returns true if this object is an article. More...
 
bool IsA (String^ pTypeName)
 Returns true if this object is an instance of the given type. More...
 
bool HasMember (String^ pMemberName)
 Returns true if this object has a member with the given name (e.g. More...
 
bool CallMethod (String^ pMethodName, String^ pArguments,[Out] String^ %pResult)
 Calls/Executes the given method with the given arguments and returns the results. More...
 
IOfmlObjectGetParent ()
 Returns the parent of this object. More...
 
ReadOnlyCollection< IOfmlObject^ >^ GetChildren (bool pElementsOnly)
 Returns the children of this object. More...
 

Properties

String^  Name [get]
 The objects name. More...
 
bool IsValid [get]
 Returns true if the IOfmlArticleInstance for this object is valid. More...
 

Detailed Description

Ofml Object.

Member Function Documentation

bool X3g::Plugin::IOfmlObject::CallMethod ( String pMethodName,
String pArguments,
[Out] String^ %  pResult 
)

Calls/Executes the given method with the given arguments and returns the results.

Also consider calling if method call modified object state.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
ReadOnlyCollection<IOfmlObject^> ^ X3g::Plugin::IOfmlObject::GetChildren ( bool  pElementsOnly)

Returns the children of this object.

If pElementsOnly is true only the children which are elements will be returned.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
IOfmlObject ^ X3g::Plugin::IOfmlObject::GetParent ( )

Returns the parent of this object.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
bool X3g::Plugin::IOfmlObject::HasMember ( String pMemberName)

Returns true if this object has a member with the given name (e.g.

a method).

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
bool X3g::Plugin::IOfmlObject::IsA ( String pTypeName)

Returns true if this object is an instance of the given type.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
bool X3g::Plugin::IOfmlObject::IsArticle ( )

Returns true if this object is an article.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
bool X3g::Plugin::IOfmlObject::IsExisting ( )

Returns true if this object still exists.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.
bool X3g::Plugin::IOfmlObject::IsSelectable ( )

Returns true if this object is selectable.

Exceptions
System::ExceptionAn exception will be thrown if this object is no longer valid.

Property Documentation

bool X3g::Plugin::IOfmlObject::IsValid
get

Returns true if the IOfmlArticleInstance for this object is valid.

String^ X3g::Plugin::IOfmlObject::Name
get

The objects name.