Class ProjectObject

Abstract base class for all objects that can be part of a Project. It can not be instantiated.

Inheritance

object

ProjectObject

ControllerSimulationConfiguration

RsInstructionArgument

RsInstructionDescription

RsInstructionParameter

RsInstructionParameterGroup

RsInstructionTemplate

SimulationConfiguration

SimulationStopwatch

TaskSimulationConfiguration

Vertex

Wire

Namespace: ABB.Robotics.RobotStudio

Assembly: ABB.Robotics.RobotStudio.dll

Syntax

public abstract class ProjectObject

Constructors

View Source

ProjectObject()

Declaration

protected ProjectObject()

View Source

ProjectObject(PimDocument)

Declaration

protected ProjectObject(PimDocument doc)

Parameters

Type	Name	Description
PimDocument	doc

Fields

View Source

_curUndoDeltaState

Declaration

[CLSCompliant(false)]
protected int _curUndoDeltaState

Field Value

Type	Description
int

Properties

View Source

Attributes

Returns a collection of dynamic attributes attached to the object

Declaration

public AttributeCollection Attributes { get; }

Property Value

Type	Description
AttributeCollection

Remarks

The attribute collection can be used to attach application-specific data to the project model. Data stored in attributes will handle UNDO and persistence correctly. ProjectObjects that represent geometry entities (such as Body, Face and Wire) are not saved in the station file, therefore Attributes cannot be used to persist their attributes.

View Source

Children

Enumerates all child objects.

Declaration

public IEnumerable<ProjectObject> Children { get; }

Property Value

Type	Description
IEnumerable<ProjectObject>

View Source

ContainingProject

Returns the Project that this object is a part of, or null if it is not part of a Project.

Declaration

public Project ContainingProject { get; }

Property Value

Type	Description
Project

View Source

DisplayName

Gets the name of the the object that should be displayed in the GUI.

Declaration

public virtual string DisplayName { get; }

Property Value

Type	Description
string

View Source

InternalChildren

Declaration

protected CmList<ProjectObject> InternalChildren { get; }

Property Value

Type	Description
CmList<ProjectObject>

View Source

InternalParent

Declaration

protected ProjectObject InternalParent { get; set; }

Property Value

Type	Description
ProjectObject

View Source

Name

Gets or sets the name of the object

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
string

View Source

Parent

Returns the objects parent, if it has one.

Declaration

public virtual ProjectObject Parent { get; }

Property Value

Type	Description
ProjectObject

View Source

TypeDisplayName

Gets a localized name for the type of this object.

Declaration

public string TypeDisplayName { get; }

Property Value

Type	Description
string

View Source

UIVisible

Gets or sets a value that indicates if this object should be displayed in GUI such as an object browser.

Declaration

public bool UIVisible { get; set; }

Property Value

Type	Description
bool

View Source

UniqueId

Gets a persisted, globally unique identifier for this object, that can be used to find the object using the GetObjectFromUniqueId(string) method.

Declaration

public string UniqueId { get; }

Property Value

Type	Description
string

Methods

View Source

AfterLoad(PimDocument)

Declaration

protected virtual void AfterLoad(PimDocument doc)

Parameters

Type	Name	Description
PimDocument	doc

View Source

Backup(bool)

Declaration

protected void Backup(bool evenIfNew = false)

Parameters

Type	Name	Description
bool	evenIfNew

View Source

BeforeSave(PimDocument)

Declaration

protected virtual void BeforeSave(PimDocument doc)

Parameters

Type	Name	Description
PimDocument	doc

View Source

FindObjects(Predicate<ProjectObject>, Predicate<ProjectObject>)

Recursively finds object that satisfy a condition.

Declaration

public IEnumerable<ProjectObject> FindObjects(Predicate<ProjectObject> filter, Predicate<ProjectObject> recurse)

Parameters

Type	Name	Description
Predicate<ProjectObject>	filter	Return true if the object should be returned.
Predicate<ProjectObject>	recurse	Return true if the recursion should continue.

Returns

Type	Description
IEnumerable<ProjectObject>

View Source

NotifyChange()

Declaration

protected void NotifyChange()

View Source

NotifyChange(ProjectObjectChangeType)

Declaration

protected void NotifyChange(ProjectObjectChangeType chType)

Parameters

Type	Name	Description
ProjectObjectChangeType	chType

View Source

OnCreatingObject()

Declaration

protected virtual void OnCreatingObject()

View Source

OnDelete()

Declaration

protected virtual void OnDelete()

View Source

OnUndoRedo()

Declaration

protected virtual void OnUndoRedo()

View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Events

View Source

DisplayNameChanged

Declaration

[Obsolete("Not supported")]
public static event ProjectObjectPropertyChangedEventHandler DisplayNameChanged

Event Type

Type	Description
ProjectObjectPropertyChangedEventHandler

View Source

InternalEvent

ABB Internal use

Declaration

public static event Action<ProjectObject, InternalEventType, object> InternalEvent

Event Type

Type	Description
Action<ProjectObject, InternalEventType, object>

View Source

ProjectObjectChanged

Occurs when the ProjectObject is changed

Declaration

public static event ProjectObjectChangedEventHandler ProjectObjectChanged

Event Type

Type	Description
ProjectObjectChangedEventHandler