TROArray

 

Creates a new instance.

constructor Create

---

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

• aCollection: collection

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

• iDest: destination object.

---

Empties the entire array and sets its size to zero. If the elements of the array are structs, binaries or other arrays, they will be freed before the array is cleared.

procedure Clear

---

Will create and return a second copy of the Array. The new instance will be a deep copy of the original array; if the members are structs, binaries or arrays themselves, they too will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent of the original class.

function Clone: TROArray

---

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

---

property ContentAsJson: UnicodeString read

---

Returns the structure of the type in a string format.

property ContentAsString: string read

---

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read

---

Contains the count of elements in the array.

property Count: Integer read

---

Deletes the i-th element of the array. If it is struct, binary or other array, it will be freed before the element is deleted.

procedure Delete(Index: Integer)

Parameters:

• Index: Index

---

property FieldCount: Integer read

---

property FieldInfo[Index: Integer]: PTypeInfo read

---

property FieldName[Index: Integer]: string read

---

procedure FreeInternalProperties

---

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

---

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString

Parameters:

• aIncludeExtraInfo:

---

function GetContentAsXml(aOffset: Integer): ROUTF8String

Parameters:

• aOffset:

---

procedure GetFieldNames(aList: TStrings)

Parameters:

• aList:

---

function GetFieldValue(const aFieldName: string): Variant

Parameters:

• aFieldName:

---

Searches for an item with a aPropertyName property, which is accessible via |GetPropValue and is equal to aPropertyValue. Returns the index of the first item found or -1.

function GetIndex(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): Integer

Parameters:

• aPropertyName: Name of the published property
• aPropertyValue: Value of the property
• StartFrom: Item index to start from
• Options: Set of TROSearchOption

---

Returns item class for non-simple arrays

class function GetItemClass: TClass

---

Returns the pointer to the array element specified by the index.

function GetItemRef(Index: Integer): Pointer

Parameters:

• Index: Item position

---

Returns the size of the data type stored in the array.

class function GetItemSize: Integer

---

Returns TypeInfo of the data type stored in the array.

class function GetItemType: PTypeInfo

---

Deserializes current class instance using provided serializer.

procedure ReadComplex(ASerializer: TObject)

Parameters:

• ASerializer: Data source (type TROSerializer).

---

Resizes the array to the specified size.

Since arrays are not a very dynamic data structure, repeatedly adding single elements can be a costly procedure, since memory needs to be reallocated for the grown array with each addittion. If the final size of the array is known in advance, it will perform better if you size it to the proper count in advance, and then simply fill the new vacancies.

procedure Resize(ElementCount: Integer)

Parameters:

• ElementCount: new size

---

procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)

Parameters:

• aRoot:
• aIncludeExtraInfo:

---

procedure SaveToXml(const aNode: TROConverterNode)

Parameters:

• aNode:

---

Searches item with specified properties

function Search(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): TCollectionItem

Parameters:

• aPropertyName: property name
• aPropertyValue: property value
• StartFrom: index
• Options: options

---

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

• aFieldName:
• aValue:

---

MUST be overwritten for arrays of non-simple types.

procedure SetItemRef(Index: Integer; Ref: Pointer)

Parameters:

• Index: Item position
• Ref: Reference to object

---

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

• Source: Instance whose properties will be copied
• TypeKinds: Specifies which properties should be copied

---

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

• aName:
• aValue:

---

Serializes current class instance using provided serializer.

procedure WriteComplex(ASerializer: TObject)

Parameters:

• ASerializer: Data sink (type TROSerializer)

 

property ContentAsJson: UnicodeString read

---

Returns the structure of the type in a string format.

property ContentAsString: string read

---

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read

---

Contains the count of elements in the array.

property Count: Integer read

---

property FieldCount: Integer read

---

property FieldInfo[Index: Integer]: PTypeInfo read

---

property FieldName[Index: Integer]: string read

 

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

---

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

Returns item class for non-simple arrays

class function GetItemClass: TClass

---

Returns the size of the data type stored in the array.

class function GetItemSize: Integer

---

Returns TypeInfo of the data type stored in the array.

class function GetItemType: PTypeInfo

---

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

• aName:
• aValue:

 

Creates a new instance.

constructor Create

---

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

• aCollection: collection

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

• iDest: destination object.

---

Empties the entire array and sets its size to zero. If the elements of the array are structs, binaries or other arrays, they will be freed before the array is cleared.

procedure Clear

---

Will create and return a second copy of the Array. The new instance will be a deep copy of the original array; if the members are structs, binaries or arrays themselves, they too will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent of the original class.

function Clone: TROArray

---

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

---

Deletes the i-th element of the array. If it is struct, binary or other array, it will be freed before the element is deleted.

procedure Delete(Index: Integer)

Parameters:

• Index: Index

---

procedure FreeInternalProperties

---

function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString

Parameters:

• aIncludeExtraInfo:

---

function GetContentAsXml(aOffset: Integer): ROUTF8String

Parameters:

• aOffset:

---

procedure GetFieldNames(aList: TStrings)

Parameters:

• aList:

---

function GetFieldValue(const aFieldName: string): Variant

Parameters:

• aFieldName:

---

Searches for an item with a aPropertyName property, which is accessible via |GetPropValue and is equal to aPropertyValue. Returns the index of the first item found or -1.

function GetIndex(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): Integer

Parameters:

• aPropertyName: Name of the published property
• aPropertyValue: Value of the property
• StartFrom: Item index to start from
• Options: Set of TROSearchOption

---

Returns the pointer to the array element specified by the index.

function GetItemRef(Index: Integer): Pointer

Parameters:

• Index: Item position

---

Deserializes current class instance using provided serializer.

procedure ReadComplex(ASerializer: TObject)

Parameters:

• ASerializer: Data source (type TROSerializer).

---

Resizes the array to the specified size.

Since arrays are not a very dynamic data structure, repeatedly adding single elements can be a costly procedure, since memory needs to be reallocated for the grown array with each addittion. If the final size of the array is known in advance, it will perform better if you size it to the proper count in advance, and then simply fill the new vacancies.

procedure Resize(ElementCount: Integer)

Parameters:

• ElementCount: new size

---

procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)

Parameters:

• aRoot:
• aIncludeExtraInfo:

---

procedure SaveToXml(const aNode: TROConverterNode)

Parameters:

• aNode:

---

Searches item with specified properties

function Search(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): TCollectionItem

Parameters:

• aPropertyName: property name
• aPropertyValue: property value
• StartFrom: index
• Options: options

---

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

• aFieldName:
• aValue:

---

MUST be overwritten for arrays of non-simple types.

procedure SetItemRef(Index: Integer; Ref: Pointer)

Parameters:

• Index: Item position
• Ref: Reference to object

---

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

• Source: Instance whose properties will be copied
• TypeKinds: Specifies which properties should be copied

---

Serializes current class instance using provided serializer.

procedure WriteComplex(ASerializer: TObject)

Parameters:

• ASerializer: Data sink (type TROSerializer)