C# Class OSAE.OSAEObjectManager

Show file Open project: opensourceautomation/Open-Source-Automation Class Usage Examples

Public Methods

Method	Description
EventTrigger ( string objectName, string eventName, string parameter1 = null, string parameter2 = null, string source = null ) : void	Add an entry to the event log table
GetObjectByAddress ( string address ) : OSAEObject	Returns an OSAEObject with the specified address
GetObjectByName ( string name ) : OSAEObject	Returns an OSAEObject with the specified name
GetObjectMethods ( string ObjectName ) : OSAEMethodCollection
GetObjectsByBaseType ( string ObjectBaseType ) : OSAEObjectCollection	Returns all objects with the specified base type
GetObjectsByContainer ( string ContainerName ) : OSAEObjectCollection	Returns a Dataset of all objects in a specified container
GetObjectsByOwner ( string ObjectOwner ) : OSAEObjectCollection
GetObjectsByPropertyValue ( string property, string value ) : OSAEObjectCollection	Returns an OSAEObject with the specified property
GetObjectsByType ( string ObjectType ) : OSAEObjectCollection	Returns a Dataset of all objects of specified type
ObjectAdd ( string name, string alias, string description, string objectType, string address, string container, int minTrustLevel, bool enabled ) : void	Create a new object
ObjectDelete ( string Name ) : void	Delete an object
ObjectDeleteByAddress ( string address ) : void	Delete an object
ObjectExists ( string objectName ) : bool	Returns true or false whether the object with the specified address exists
ObjectExistsByAddress ( string address ) : bool	Returns true or false whether the object with the specified address exists
ObjectExistsInContainer ( string pObject, string pContainer ) : bool	Returns true or false whether the object with the specified address exists
ObjectExport ( string ObjectName ) : string	Get Export script for object
ObjectUpdate ( string oldName, string newName, string alias, string description, string objectType, string address, string container, int minTrustLevel, bool enabled ) : void	Update an existing object

Method Details

EventTrigger() public static method

Add an entry to the event log table

public static EventTrigger ( string objectName, string eventName, string parameter1 = null, string parameter2 = null, string source = null ) : void
objectName	string	Object Name
eventName	string	Event Name
parameter1	string
parameter2	string
source	string
return	void

GetObjectByAddress() public static method

Returns an OSAEObject with the specified address

public static GetObjectByAddress ( string address ) : OSAEObject
address	string
return	OSAEObject

GetObjectByName() public static method

Returns an OSAEObject with the specified name

public static GetObjectByName ( string name ) : OSAEObject
name	string
return	OSAEObject

GetObjectMethods() public static method

public static GetObjectMethods ( string ObjectName ) : OSAEMethodCollection
ObjectName	string
return	OSAEMethodCollection

GetObjectsByBaseType() public static method

Returns all objects with the specified base type

public static GetObjectsByBaseType ( string ObjectBaseType ) : OSAEObjectCollection
ObjectBaseType	string
return	OSAEObjectCollection

GetObjectsByContainer() public static method

Returns a Dataset of all objects in a specified container

public static GetObjectsByContainer ( string ContainerName ) : OSAEObjectCollection
ContainerName	string
return	OSAEObjectCollection

GetObjectsByOwner() public static method

public static GetObjectsByOwner ( string ObjectOwner ) : OSAEObjectCollection
ObjectOwner	string
return	OSAEObjectCollection

GetObjectsByPropertyValue() public static method

Returns an OSAEObject with the specified property

public static GetObjectsByPropertyValue ( string property, string value ) : OSAEObjectCollection
property	string
value	string
return	OSAEObjectCollection

GetObjectsByType() public static method

Returns a Dataset of all objects of specified type

public static GetObjectsByType ( string ObjectType ) : OSAEObjectCollection
ObjectType	string
return	OSAEObjectCollection

ObjectAdd() public static method

Create a new object

public static ObjectAdd ( string name, string alias, string description, string objectType, string address, string container, int minTrustLevel, bool enabled ) : void
name	string
alias	string
description	string
objectType	string
address	string
container	string
minTrustLevel	int
enabled	bool
return	void

ObjectDelete() public static method

Delete an object

public static ObjectDelete ( string Name ) : void
Name	string
return	void

ObjectDeleteByAddress() public static method

Delete an object

public static ObjectDeleteByAddress ( string address ) : void
address	string
return	void

ObjectExists() public static method

Returns true or false whether the object with the specified address exists

public static ObjectExists ( string objectName ) : bool
objectName	string
return	bool

ObjectExistsByAddress() public static method

Returns true or false whether the object with the specified address exists

public static ObjectExistsByAddress ( string address ) : bool
address	string
return	bool

ObjectExistsInContainer() public static method

Returns true or false whether the object with the specified address exists

public static ObjectExistsInContainer ( string pObject, string pContainer ) : bool
pObject	string
pContainer	string
return	bool

ObjectExport() public static method

Get Export script for object

public static ObjectExport ( string ObjectName ) : string
ObjectName	string
return	string

ObjectUpdate() public static method

Update an existing object

public static ObjectUpdate ( string oldName, string newName, string alias, string description, string objectType, string address, string container, int minTrustLevel, bool enabled ) : void
oldName	string
newName	string
alias	string
description	string
objectType	string
address	string
container	string
minTrustLevel	int
enabled	bool
return	void