TxtWithImagesFileComparator {verifyr2} | R Documentation |
TxtWithImageFileComparator.R
Description
TxtWithImageFileComparator.R
TxtWithImageFileComparator.R
Details
"Abstract" comparator for txt based comparator classes that can additionally contain embedded images. This abstraction level contains generic logic for handling embedded images and storing the related data.
Super classes
verifyr2::FileComparator
-> verifyr2::BinaryFileComparator
-> verifyr2::TxtFileComparator
-> TxtWithImagesFileComparator
Public fields
file1_images_raw
local property for storing image1 raw data
file2_images_raw
local property for storing image2 raw data
Methods
Public methods
Inherited methods
verifyr2::FileComparator$vrf_add_debug()
verifyr2::FileComparator$vrf_add_debug_files()
verifyr2::FileComparator$vrf_close_debug()
verifyr2::FileComparator$vrf_details()
verifyr2::FileComparator$vrf_open_debug()
verifyr2::FileComparator$vrf_option_value()
verifyr2::FileComparator$vrf_summary()
verifyr2::BinaryFileComparator$vrf_contents()
verifyr2::TxtFileComparator$vrf_contents_inner()
verifyr2::TxtFileComparator$vrf_details_supported()
Method new()
Initialize a TxtWithImagesFileComparator instance
Usage
TxtWithImagesFileComparator$new(file1 = NULL, file2 = NULL)
Arguments
file1
First file to compare.
file2
Second file to compare.
Method vrf_summary_inner()
Method for comparing the inner part for the details query. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn't be called directly by the user.
Usage
TxtWithImagesFileComparator$vrf_summary_inner(config, omit)
Arguments
config
configuration values
omit
string pattern to omit from the comparison
Method vrf_details_inner()
Method for comparing the inner part for the details query. This method can be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn't be called directly by the user.
Usage
TxtWithImagesFileComparator$vrf_details_inner(config, omit)
Arguments
config
configuration values
omit
string pattern to omit from the comparison
Method vrf_images()
"Abstract" method for getting the raw image hex vector array from the given source file.
Usage
TxtWithImagesFileComparator$vrf_images(file)
Arguments
file
file for which to get the embedded image details
Method hex2raw()
Internal helper method for converting a hex string to raw vector.
Usage
TxtWithImagesFileComparator$hex2raw(hex_string)
Arguments
hex_string
hexadecimal string to be converted to raw vector
Method clone()
The objects of this class are cloneable with this method.
Usage
TxtWithImagesFileComparator$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.