TRODLLibrary

Overview

The TRODLLibrary class is used as an in-memory representation of a RODL file. It provides strongly-typed access to the services, and types defined within the RODL.

Location

 

constructor Create  override

Creates a new instance with a unique GUID.

constructor Create

Abstract    (declared in TRODLComplexEntity)

Equals true if the current TRODLComplexEntity object describes abstract objects, otherwise equals false.

property Abstract: boolean read write

Add  overload virtual    (declared in TRODLComplexEntity)

Adds a new object to the Items collection.

function Add: TRODLEntity

Add (TRODLEntity): integer  override

Adds specified object to the Items collection.

function Add(anEntity: TRODLEntity): integer

Parameters:

  • anEntity:

ArrayCount

Returns the number of TRODLArray objects in the current library.

property ArrayCount: integer read write

Arrays

Contains the collection of TRODLArray objects (section Arrays in the RODL file).

property Arrays[Index: integer]: TRODLArray read write

Assign  virtual    (declared in TRODLEntity)

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read write

AutoCreateParams    (declared in TRODLComplexEntity)

Equals true if the described object has the ability to autocreate fields, otherwise equals false.

property AutoCreateParams: boolean read write

CalcArrayOrder

Organizes the Arrays collection.

function CalcArrayOrder: IROStrings

CalcEnumOrder

Organizes the Enums collection.

function CalcEnumOrder: IROStrings

CalcEventSinkOrder

Organizes the EventSinks collection. First, the TRODLEventSink objects without ancestors or with ancestors that are not defined in the current RODL file are added. Then, the TRODLEventSink objects with ancestors defined in the current RODL file are added.

function CalcEventSinkOrder: IROStrings

CalcExceptionOrder

Organizes the Exceptions collection. First, the TRODLException objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLException objects with ancestors defined in the current RODL file are added.

function CalcExceptionOrder: IROStrings

CalcServiceOrder

Organizes the Services collection. First, the TRODLService objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLService objects with ancestors defined in the current RODL file are added.

function CalcServiceOrder: IROStrings

CalcStructOrder

Organizes the Structs collection. First, the TRODLStruct objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLStruct objects with ancestors defined in the current RODL file are added.

function CalcStructOrder: IROStrings

CheckForUsableName

function CheckForUsableName(aName: string): Boolean

Parameters:

  • aName:

Clear  override

Clears the Items collection.

procedure Clear

ClearDuplicates

Clears duplicates in all items of the current library.

procedure ClearDuplicates

ContainsEntity    (declared in TRODLComplexEntity)

Returns true if the aEntity object is found in the Items collection. If aRecurse is true, it searches recursively on all objects in the Items collection. By default, aRecurse is true.

function ContainsEntity(aEntity: TRODLEntity; aRecurse: boolean): boolean

Parameters:

  • aEntity: Object;
  • aRecurse: If true, the method searches recursively on all objects;

Count    (declared in TRODLComplexEntity)

Count of items in the Items collection.

property Count: integer read write

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

DataSnapMode

Sets DataSnap compatible mode

property DataSnapMode: Boolean read write

Delete  override

Deletes items with the specified Index from the Items collection.

procedure Delete(Index: integer)

Parameters:

  • Index: Index of item that will be deleted;

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: boolean read write

EnumCount

Returns the number of TRODLEnum objects in the current library.

property EnumCount: integer read write

Enums

Contains the collection of TRODLEnum objects (section Enums in the RODL file).

property Enums[Index: integer]: TRODLEnum read write

EventSinkCount

Returns the number of TRODLEventSink objects in the current library.

property EventSinkCount: integer read write

EventSinks

Contains the collection of TRODLEventSink objects (section EventSinks in the RODL file).

property EventSinks[Index: integer]: TRODLEventSink read write

ExceptionCount

Returns the number of TRODLException objects in the current library.

property ExceptionCount: integer read write

Exceptions

Contains the collection of TRODLException objects (section Exceptions in the RODL file).

property Exceptions[Index: integer]: TRODLException read write

Exchange  virtual    (declared in TRODLComplexEntity)

Exchanges two items in Items collection.

procedure Exchange(Index1: integer; Index2: integer)

Parameters:

  • Index1: First item index;
  • Index2: Second item index;

FindArray

Finds an TRODLArray object with the specified iArrayName name in the Arrays collection.

function FindArray(const iArrayName: string): TRODLArray

Parameters:

  • iArrayName:

FindBaseService

Finds a TRODLBaseService object with the specified iServiceName name in the Items collection.

function FindBaseService(const iServiceName: string): TRODLBaseService

Parameters:

  • iServiceName:

FindBaseStruct

Finds a TRODLBaseStruct object with the specified iStructName name in the Items collection.

function FindBaseStruct(const iStructName: string): TRODLBaseStruct

Parameters:

  • iStructName:

FindEnum

Finds a TRODLEnum object with the specified iEnumName name in the Enums collection.

function FindEnum(const iEnumName: string): TRODLEnum

Parameters:

  • iEnumName:

FindException

Finds a TRODLException object with the specified iExceptionName name in the Exceptions collection.

function FindException(const iExceptionName: string): TRODLException

Parameters:

  • iExceptionName: Excaption name

FindGroup (TGUID): TRODLGroup  overload

Finds a TRODLGroup object with the specified aID GUID in the Groups collection.

function FindGroup(const aID: TGUID): TRODLGroup

Parameters:

  • aID:

FindService

Finds a TRODLService object with the specified iServiceName name in the Services collection.

function FindService(const iServiceName: string): TRODLService

Parameters:

  • iServiceName:

FindStruct

Finds a TRODLStruct object with the specified iStructName name in the Structs collection.

function FindStruct(const iStructName: string): TRODLStruct

Parameters:

  • iStructName:

FindUse

Finds a TRODLUse object with the specified iUseName name in the Use collection.

function FindUse(const iUseName: string): TRODLUse

Parameters:

  • iUseName:

FindUseByFilename

Finds a TRODLUse object with the specified iUseRODLFile filename in the Use collection.

function FindUseByFilename(const iUseRODLFile: string): TRODLUse

Parameters:

  • iUseRODLFile:

FindUseByUsedRodlID

Finds a TRODLUse object with the specified aID GUID in the Use collection.

function FindUseByUsedRodlID(const aID: TGUID): TRODLUse

Parameters:

  • aID:

GetArraysByElement (string, TList<TRODLArray>)  overload

Finds and saves the TRODLArray objects whose field ElementType is the same as aElementName. The result is saved in the TList object.

procedure GetArraysByElement(const aElementName: string; AList: TList<TRODLArray>)

Parameters:

  • aElementName:
  • AList:

GetArraysByElement (string, TStringList)  overload

Finds and saves the TRODLArray objects whose field ElementType is the same as aElementName. The result is saved in the TStringList object.

procedure GetArraysByElement(const aElementName: string; AList: TStringList)

Parameters:

  • aElementName:
  • AList:

GetDontCodegen  protected virtual    (declared in TRODLEntity)

function GetDontCodegen: boolean

GetItemClass  protected override

Returns the TRODLEntity class.

function GetItemClass: TRODLEntityClass

GetService

Finds the TRODLService object with the specified aServiceName name. If the TRODLService object is not defined, an exception is raised.

function GetService(const aServiceName: string): TRODLService

Parameters:

  • aServiceName:

GetStruct

Finds the TRODLStruct object with the specified aStructName name. If the TRODLStruct object is not defined, an exception is raised.

function GetStruct(const aStructName: string): TRODLStruct

Parameters:

  • aStructName:

GroupCount

Returns the number of TRODLGroup objects in the current library.

property GroupCount: integer read write

Groups

Contains the collection of TRODLGroup objects (section Groups in the RODL file).

property Groups[Index: integer]: TRODLGroup read write

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Includes

Contains the collection of TRODLIncludes objects

property Includes: TRODLIncludes read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read write

Insert (integer): TRODLEntity  overload virtual    (declared in TRODLComplexEntity)

Inserts a new object to the Items collection in the specified aIndex position.

function Insert(aIndex: integer): TRODLEntity

Parameters:

  • aIndex:

Insert (integer, TRODLEntity)  overload virtual    (declared in TRODLComplexEntity)

Inserts an anEntity object to the Items collection in the specified aIndex position.

procedure Insert(aIndex: integer; anEntity: TRODLEntity)

Parameters:

  • aIndex:
  • anEntity:

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read write

InUseCount    (declared in TRODLEntity)

property InUseCount: integer read write

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: boolean read write

IsValidCustomType

Returns true if the type iTypeName is defined in the Arrays, Structs or Enums collection. Otherwise returns false.

function IsValidCustomType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidEventSink

Returns true if the TRODLEventSink object with the specified iEventSink name is defined. Otherwise returns false.

function IsValidEventSink(const iEventSink: string): boolean

Parameters:

  • iEventSink: type name

IsValidException

Returns true if the TRODLException object with the specified iTypeName name is defined. Otherwise returns false.

function IsValidException(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidService

Returns true if the TRODLService object with the specified iServiceName name is defined. Otherwise returns false.

function IsValidService(const iServiceName: string): boolean

Parameters:

  • iServiceName: type name

IsValidSimpleType

Returns true if the type iTypeName is defined in the TRODataType or the DataTypeRemapping enum. Otherwise returns false.

function IsValidSimpleType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidType

Returns true if the IsValidCustomType or the IsValidSimpleType function returns true. Otherwise returns false.

function IsValidType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

ItemByName    (declared in TRODLComplexEntity)

Returns the item with the specified aName name in the Items collection.

function ItemByName(const aName: string): TRODLEntity

Parameters:

  • aName:

ItemByUID    (declared in TRODLComplexEntity)

Returns the item with the specified aUID UID in the Items collection.

function ItemByUID(const aUID: TGUID): TRODLEntity

Parameters:

  • aUID:

ItemClass    (declared in TRODLComplexEntity)

Contains the class name of the current object.

property ItemClass: TRODLEntityClass read write

Items    (declared in TRODLComplexEntity)

Contains the collection of TRODLEntity objects.

property Items[Index: integer]: TRODLEntity read write

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

Namespace

Namespace of the current TRODLLibrary object.

property Namespace: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read write

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read write

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

Remove  override

Removes the specified object from the Items collection.

procedure Remove(anEntity: TRODLEntity)

Parameters:

  • anEntity: Object that will be removed;

RemoveUnusedItems

Removes unused items from library

procedure RemoveUnusedItems

Rename

Renames anEntity with new name

procedure Rename(anEntity: TRODLEntity; aNewName: string)

Parameters:

  • anEntity:
  • aNewName:

RodlFilename

The name of the RODL file.

property RodlFilename: string read write

ScopedEnums

property ScopedEnums: Boolean read write

ServiceCount

Returns the number of TRODLService objects in the current library.

property ServiceCount: integer read write

Services

Contains the collection of TRODLService objects (section Services in the RODL file).

property Services[Index: integer]: TRODLService read write

Sort    (declared in TRODLComplexEntity)

Sorts items in Items collection.

procedure Sort

StructCount

Returns the number of the TRODLStruct objects in the current library.

property StructCount: integer read write

Structs

Contains the collection of TRODLStruct objects.

property Structs[Index: integer]: TRODLStruct read write

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

UniqueName    (declared in TRODLComplexEntity)

Generates unique names based on the aBaseName.

function UniqueName(aBaseName: string): string

Parameters:

  • aBaseName:

Use

Contains the collection of TRODLUse objects (Uses section in the RODL file).

property Use[Index: integer]: TRODLUse read write

UseCount

Returns the number of TRODLUse objects in the current library.

property UseCount: integer read write

UseRODL

procedure UseRODL(aFileName: string; iMessages: IROPluginMessages)

Parameters:

  • aFileName:
  • iMessages:

Validate  override    (declared in TRODLComplexEntity)

Validates the current object.

procedure Validate(iMessages: IROPluginMessages)

Parameters:

  • iMessages: plugin

 

Abstract    (declared in TRODLComplexEntity)

Equals true if the current TRODLComplexEntity object describes abstract objects, otherwise equals false.

property Abstract: boolean read write

ArrayCount

Returns the number of TRODLArray objects in the current library.

property ArrayCount: integer read write

Arrays

Contains the collection of TRODLArray objects (section Arrays in the RODL file).

property Arrays[Index: integer]: TRODLArray read write

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read write

AutoCreateParams    (declared in TRODLComplexEntity)

Equals true if the described object has the ability to autocreate fields, otherwise equals false.

property AutoCreateParams: boolean read write

Count    (declared in TRODLComplexEntity)

Count of items in the Items collection.

property Count: integer read write

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

DataSnapMode

Sets DataSnap compatible mode

property DataSnapMode: Boolean read write

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: boolean read write

EnumCount

Returns the number of TRODLEnum objects in the current library.

property EnumCount: integer read write

Enums

Contains the collection of TRODLEnum objects (section Enums in the RODL file).

property Enums[Index: integer]: TRODLEnum read write

EventSinkCount

Returns the number of TRODLEventSink objects in the current library.

property EventSinkCount: integer read write

EventSinks

Contains the collection of TRODLEventSink objects (section EventSinks in the RODL file).

property EventSinks[Index: integer]: TRODLEventSink read write

ExceptionCount

Returns the number of TRODLException objects in the current library.

property ExceptionCount: integer read write

Exceptions

Contains the collection of TRODLException objects (section Exceptions in the RODL file).

property Exceptions[Index: integer]: TRODLException read write

GroupCount

Returns the number of TRODLGroup objects in the current library.

property GroupCount: integer read write

Groups

Contains the collection of TRODLGroup objects (section Groups in the RODL file).

property Groups[Index: integer]: TRODLGroup read write

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Includes

Contains the collection of TRODLIncludes objects

property Includes: TRODLIncludes read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read write

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read write

InUseCount    (declared in TRODLEntity)

property InUseCount: integer read write

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: boolean read write

ItemClass    (declared in TRODLComplexEntity)

Contains the class name of the current object.

property ItemClass: TRODLEntityClass read write

Items    (declared in TRODLComplexEntity)

Contains the collection of TRODLEntity objects.

property Items[Index: integer]: TRODLEntity read write

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

Namespace

Namespace of the current TRODLLibrary object.

property Namespace: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read write

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read write

RodlFilename

The name of the RODL file.

property RodlFilename: string read write

ScopedEnums

property ScopedEnums: Boolean read write

ServiceCount

Returns the number of TRODLService objects in the current library.

property ServiceCount: integer read write

Services

Contains the collection of TRODLService objects (section Services in the RODL file).

property Services[Index: integer]: TRODLService read write

StructCount

Returns the number of the TRODLStruct objects in the current library.

property StructCount: integer read write

Structs

Contains the collection of TRODLStruct objects.

property Structs[Index: integer]: TRODLStruct read write

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

Use

Contains the collection of TRODLUse objects (Uses section in the RODL file).

property Use[Index: integer]: TRODLUse read write

UseCount

Returns the number of TRODLUse objects in the current library.

property UseCount: integer read write

 

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

 

constructor Create  override

Creates a new instance with a unique GUID.

constructor Create

Add  overload virtual    (declared in TRODLComplexEntity)

Adds a new object to the Items collection.

function Add: TRODLEntity

Add (TRODLEntity): integer  override

Adds specified object to the Items collection.

function Add(anEntity: TRODLEntity): integer

Parameters:

  • anEntity:

Assign  virtual    (declared in TRODLEntity)

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

CalcArrayOrder

Organizes the Arrays collection.

function CalcArrayOrder: IROStrings

CalcEnumOrder

Organizes the Enums collection.

function CalcEnumOrder: IROStrings

CalcEventSinkOrder

Organizes the EventSinks collection. First, the TRODLEventSink objects without ancestors or with ancestors that are not defined in the current RODL file are added. Then, the TRODLEventSink objects with ancestors defined in the current RODL file are added.

function CalcEventSinkOrder: IROStrings

CalcExceptionOrder

Organizes the Exceptions collection. First, the TRODLException objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLException objects with ancestors defined in the current RODL file are added.

function CalcExceptionOrder: IROStrings

CalcServiceOrder

Organizes the Services collection. First, the TRODLService objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLService objects with ancestors defined in the current RODL file are added.

function CalcServiceOrder: IROStrings

CalcStructOrder

Organizes the Structs collection. First, the TRODLStruct objects without ancestors or with ancestors not defined in the current RODL file are added. Then, the TRODLStruct objects with ancestors defined in the current RODL file are added.

function CalcStructOrder: IROStrings

CheckForUsableName

function CheckForUsableName(aName: string): Boolean

Parameters:

  • aName:

Clear  override

Clears the Items collection.

procedure Clear

ClearDuplicates

Clears duplicates in all items of the current library.

procedure ClearDuplicates

ContainsEntity    (declared in TRODLComplexEntity)

Returns true if the aEntity object is found in the Items collection. If aRecurse is true, it searches recursively on all objects in the Items collection. By default, aRecurse is true.

function ContainsEntity(aEntity: TRODLEntity; aRecurse: boolean): boolean

Parameters:

  • aEntity: Object;
  • aRecurse: If true, the method searches recursively on all objects;

Delete  override

Deletes items with the specified Index from the Items collection.

procedure Delete(Index: integer)

Parameters:

  • Index: Index of item that will be deleted;

Exchange  virtual    (declared in TRODLComplexEntity)

Exchanges two items in Items collection.

procedure Exchange(Index1: integer; Index2: integer)

Parameters:

  • Index1: First item index;
  • Index2: Second item index;

FindArray

Finds an TRODLArray object with the specified iArrayName name in the Arrays collection.

function FindArray(const iArrayName: string): TRODLArray

Parameters:

  • iArrayName:

FindBaseService

Finds a TRODLBaseService object with the specified iServiceName name in the Items collection.

function FindBaseService(const iServiceName: string): TRODLBaseService

Parameters:

  • iServiceName:

FindBaseStruct

Finds a TRODLBaseStruct object with the specified iStructName name in the Items collection.

function FindBaseStruct(const iStructName: string): TRODLBaseStruct

Parameters:

  • iStructName:

FindEnum

Finds a TRODLEnum object with the specified iEnumName name in the Enums collection.

function FindEnum(const iEnumName: string): TRODLEnum

Parameters:

  • iEnumName:

FindException

Finds a TRODLException object with the specified iExceptionName name in the Exceptions collection.

function FindException(const iExceptionName: string): TRODLException

Parameters:

  • iExceptionName: Excaption name

FindGroup (TGUID): TRODLGroup  overload

Finds a TRODLGroup object with the specified aID GUID in the Groups collection.

function FindGroup(const aID: TGUID): TRODLGroup

Parameters:

  • aID:

FindService

Finds a TRODLService object with the specified iServiceName name in the Services collection.

function FindService(const iServiceName: string): TRODLService

Parameters:

  • iServiceName:

FindStruct

Finds a TRODLStruct object with the specified iStructName name in the Structs collection.

function FindStruct(const iStructName: string): TRODLStruct

Parameters:

  • iStructName:

FindUse

Finds a TRODLUse object with the specified iUseName name in the Use collection.

function FindUse(const iUseName: string): TRODLUse

Parameters:

  • iUseName:

FindUseByFilename

Finds a TRODLUse object with the specified iUseRODLFile filename in the Use collection.

function FindUseByFilename(const iUseRODLFile: string): TRODLUse

Parameters:

  • iUseRODLFile:

FindUseByUsedRodlID

Finds a TRODLUse object with the specified aID GUID in the Use collection.

function FindUseByUsedRodlID(const aID: TGUID): TRODLUse

Parameters:

  • aID:

GetArraysByElement (string, TList<TRODLArray>)  overload

Finds and saves the TRODLArray objects whose field ElementType is the same as aElementName. The result is saved in the TList object.

procedure GetArraysByElement(const aElementName: string; AList: TList<TRODLArray>)

Parameters:

  • aElementName:
  • AList:

GetArraysByElement (string, TStringList)  overload

Finds and saves the TRODLArray objects whose field ElementType is the same as aElementName. The result is saved in the TStringList object.

procedure GetArraysByElement(const aElementName: string; AList: TStringList)

Parameters:

  • aElementName:
  • AList:

GetDontCodegen  protected virtual    (declared in TRODLEntity)

function GetDontCodegen: boolean

GetItemClass  protected override

Returns the TRODLEntity class.

function GetItemClass: TRODLEntityClass

GetService

Finds the TRODLService object with the specified aServiceName name. If the TRODLService object is not defined, an exception is raised.

function GetService(const aServiceName: string): TRODLService

Parameters:

  • aServiceName:

GetStruct

Finds the TRODLStruct object with the specified aStructName name. If the TRODLStruct object is not defined, an exception is raised.

function GetStruct(const aStructName: string): TRODLStruct

Parameters:

  • aStructName:

Insert (integer): TRODLEntity  overload virtual    (declared in TRODLComplexEntity)

Inserts a new object to the Items collection in the specified aIndex position.

function Insert(aIndex: integer): TRODLEntity

Parameters:

  • aIndex:

Insert (integer, TRODLEntity)  overload virtual    (declared in TRODLComplexEntity)

Inserts an anEntity object to the Items collection in the specified aIndex position.

procedure Insert(aIndex: integer; anEntity: TRODLEntity)

Parameters:

  • aIndex:
  • anEntity:

IsValidCustomType

Returns true if the type iTypeName is defined in the Arrays, Structs or Enums collection. Otherwise returns false.

function IsValidCustomType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidEventSink

Returns true if the TRODLEventSink object with the specified iEventSink name is defined. Otherwise returns false.

function IsValidEventSink(const iEventSink: string): boolean

Parameters:

  • iEventSink: type name

IsValidException

Returns true if the TRODLException object with the specified iTypeName name is defined. Otherwise returns false.

function IsValidException(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidService

Returns true if the TRODLService object with the specified iServiceName name is defined. Otherwise returns false.

function IsValidService(const iServiceName: string): boolean

Parameters:

  • iServiceName: type name

IsValidSimpleType

Returns true if the type iTypeName is defined in the TRODataType or the DataTypeRemapping enum. Otherwise returns false.

function IsValidSimpleType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

IsValidType

Returns true if the IsValidCustomType or the IsValidSimpleType function returns true. Otherwise returns false.

function IsValidType(const iTypeName: string): boolean

Parameters:

  • iTypeName: type name

ItemByName    (declared in TRODLComplexEntity)

Returns the item with the specified aName name in the Items collection.

function ItemByName(const aName: string): TRODLEntity

Parameters:

  • aName:

ItemByUID    (declared in TRODLComplexEntity)

Returns the item with the specified aUID UID in the Items collection.

function ItemByUID(const aUID: TGUID): TRODLEntity

Parameters:

  • aUID:

Remove  override

Removes the specified object from the Items collection.

procedure Remove(anEntity: TRODLEntity)

Parameters:

  • anEntity: Object that will be removed;

RemoveUnusedItems

Removes unused items from library

procedure RemoveUnusedItems

Rename

Renames anEntity with new name

procedure Rename(anEntity: TRODLEntity; aNewName: string)

Parameters:

  • anEntity:
  • aNewName:

Sort    (declared in TRODLComplexEntity)

Sorts items in Items collection.

procedure Sort

UniqueName    (declared in TRODLComplexEntity)

Generates unique names based on the aBaseName.

function UniqueName(aBaseName: string): string

Parameters:

  • aBaseName:

UseRODL

procedure UseRODL(aFileName: string; iMessages: IROPluginMessages)

Parameters:

  • aFileName:
  • iMessages:

Validate  override    (declared in TRODLComplexEntity)

Validates the current object.

procedure Validate(iMessages: IROPluginMessages)

Parameters:

  • iMessages: plugin

See Also