Clone
1
Reference
Stone_Red edited this page 2024-04-18 09:00:31 +02:00

CuteUtils

Contents

BlockingTaskQueue type

Namespace

CuteUtils.Tasks

Summary

Represents a blocking task queue that allows enqueueing tasks and functions.

#ctor() constructor

Summary

Initializes a new instance of the BlockingTaskQueue class.

Parameters

This constructor has no parameters.

Enqueue(function) method

Summary

Enqueues a task that does not return a value.

Returns

A task representing the asynchronous operation.

Parameters
Name Type Description
function System.Action The action to execute.

Enqueue(task) method

Summary

Enqueues a task.

Returns

A task representing the asynchronous operation.

Parameters
Name Type Description
task System.Threading.Tasks.Task The task to enqueue.

Enqueue``1(function) method

Summary

Enqueues a task that returns a value.

Returns

A task representing the asynchronous operation.

Parameters
Name Type Description
function System.Func{``0} The function to execute.
Generic Types
Name Description
T The type of the return value.

Enqueue``1(task) method

Summary

Enqueues a task that returns a value.

Returns

A task representing the asynchronous operation.

Parameters
Name Type Description
task System.Threading.Tasks.Task{``0} The task to enqueue.
Generic Types
Name Description
T The type of the return value.

BoolExt type

Namespace

CuteUtils.Misc

Summary

Boolean Extensions

FromInt(bol,input) method

Summary

Converts int to bool.

Parameters
Name Type Description
bol System.Boolean@
input System.Int32

OneWayFalse(value,input) method

Summary

Sets value to false if input is false. If input is true the value will not change.

Parameters
Name Type Description
value System.Boolean@
input System.Boolean

OneWayTrue(value,input) method

Summary

Sets value to true if input is true. If input is false the value will not change.

Parameters
Name Type Description
value System.Boolean@
input System.Boolean

ToInt(input) method

Summary

Converts bool to int.

Returns
Parameters
Name Type Description
input System.Boolean

Circle type

Namespace

CuteUtils.FluentMath.Shapes

Summary

Represents a circle shape.

Parameters
Name Type Description
radius T:CuteUtils.FluentMath.Shapes.Circle The radius of the circle.
Remarks

Initializes a new instance of the Circle class with the specified radius.

#ctor(radius) constructor

Summary

Represents a circle shape.

Parameters
Name Type Description
radius System.Double The radius of the circle.
Remarks

Initializes a new instance of the Circle class with the specified radius.

Area property

Summary

Gets the area of the circle.

Circumference property

Summary

Gets the circumference of the circle.

Diameter property

Summary

Gets the diameter of the circle.

Radius property

Summary

Gets or sets the radius of the circle.

CollectionExt type

Namespace

CuteUtils.Misc

Summary

IEnumerable`1 and Array Extensions

PrintTable``1(array,tableStyle) method

Summary

Prints the elements of the 2D array in a table format.

Parameters
Name Type Description
array [``00: The 2D array to print.
tableStyle [0:]](#T-0-] '0:]') The style of the table. Default is TableStyle.Default.
Generic Types
Name Description
T The type of the elements in the array.

Print``1(collection,delimiter,printToDebugConsole) method

Summary

Prints the elements of the collection.

Parameters
Name Type Description
collection System.Collections.Generic.IEnumerable{``0} The collection to print.
delimiter System.Char The delimiter character to use between elements. Default is ','.
printToDebugConsole System.Boolean Indicates whether to print to the debug console. Default is false.
Generic Types
Name Description
T The type of the elements in the collection.

ConsoleExt type

Namespace

CuteUtils.Misc

Summary

Console Extensions

Pause(key,message) method

Summary

Suspends execution of the current method until the user presses a key.

Parameters
Name Type Description
key System.ConsoleKey The key that has to be pressed.
message System.String The message that will be displayed.

Pause(message) method

Summary

Suspends execution of the current method until the user presses a key.

Parameters
Name Type Description
message System.String The message that will be displayed.

ReadKey``1() method

Summary

Obtains the next character or function key pressed by the user and converts it to the specified type. The pressed key is displayed in the console window.

Returns

The input character converted to the specified type.

Parameters

This method has no parameters.

Generic Types
Name Description
T The type to convert the input character to.
Exceptions
Name Description
System.NotSupportedException Thrown if the conversion is not supported.

ReadLine``1() method

Summary

Reads the next line of characters from the standard input stream and tries to convert it to the specified type.

Returns

The input string converted to the specified type.

Parameters

This method has no parameters.

Generic Types
Name Description
T The type to convert the input string to.
Exceptions
Name Description
System.NotSupportedException Thrown if the conversion is not supported.

TryReadKey``1(input) method

Summary

Obtains the next character or function key pressed by the user and tries to convert it to the specified type. The pressed key is displayed in the console window.

Returns

true if the conversion was successful. Otherwise false.

Parameters
Name Type Description
input ``0@ The input character converted to the specified type.
Generic Types
Name Description
T The type to convert the input character to.

TryReadLine``1(input) method

Summary

Reads the next line of characters from the standard input stream and tries to convert it to the specified type.

Returns

true if the conversion was successful. Otherwise false.

Parameters
Name Type Description
input ``0@ The input string converted to the specified type.
Generic Types
Name Description
T The type to convert the input string to.

Write(value,color) method

Summary

Writes the specified value to the console with the specified color.

Parameters
Name Type Description
value System.Object The value to write.
color System.ConsoleColor The color of the text.

WriteLine(value,color) method

Summary

Writes the specified value to the console with the specified color and appends a new line.

Parameters
Name Type Description
value System.Object The value to write.
color System.ConsoleColor The color of the text.

DecimalFluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

DecimalFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Decimal
value System.Decimal

Ceiling() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Decimal
value System.Decimal

Floor() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Decimal
value System.Decimal

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Decimal
value System.Decimal

ToDouble(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Decimal

ToInt16(num) method

Summary

Converts number to Int16

Returns

Number as Int16

Parameters
Name Type Description
num System.Decimal

ToInt32(num) method

Summary

Converts number to Int32

Returns

Number as Int32

Parameters
Name Type Description
num System.Decimal

ToInt64(num) method

Summary

Converts number to Int64

Returns

Number as Int64

Parameters
Name Type Description
num System.Decimal

ToSingle(num) method

Summary

Converts number to Single

Returns

Number as Single

Parameters
Name Type Description
num System.Decimal

Truncate() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

DoubleFluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

DoubleFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Acos() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Acosh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Double
value System.Double

Asin() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Asinh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atan() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atan2() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atanh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cbrt() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Ceiling() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cos() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cosh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Double
value System.Double

Exp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Floor() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

IEEERemainder() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log10() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Double
value System.Double

Pow() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sin() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sinh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sqrt() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Double
value System.Double

Tan() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Tanh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

ToDecimal(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Double

ToInt16(num) method

Summary

Converts number to Int16

Returns

Number as Int16

Parameters
Name Type Description
num System.Double

ToInt32(num) method

Summary

Converts number to Int32

Returns

Number as Int32

Parameters
Name Type Description
num System.Double

ToInt64(num) method

Summary

Converts number to Int64

Returns

Number as Int64

Parameters
Name Type Description
num System.Double

ToSingle(num) method

Summary

Converts number to Single

Returns

Number as Single

Parameters
Name Type Description
num System.Double

Truncate() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

DynDto type

Namespace

CuteUtils.Reflection

Summary

Provides utility methods for converting objects to and from dynamic DTOs.

FromDto``1(dto,data) method

Summary

Converts a dynamic DTO to an object.

Returns

The populated object.

Parameters
Name Type Description
dto System.Object The dynamic DTO.
data ``0 The object instance to populate.
Generic Types
Name Description
T The type of object.

FromDto``1(dto,data) method

Summary

Converts a dynamic DTO to an object.

Returns

The populated object.

Parameters
Name Type Description
dto System.Dynamic.ExpandoObject The dynamic DTO.
data ``0 The new instance of the object.
Generic Types
Name Description
T The type of object.

FromDto``1(dto) method

Summary

Converts a dynamic DTO to a new instance of an object.

Returns

The new instance of the object.

Parameters
Name Type Description
dto System.Object The dynamic DTO.
Generic Types
Name Description
T The type of object.

FromDto``1(dto) method

Summary

Converts a dynamic DTO to a new instance of an object.

Returns

The new instance of the object.

Parameters
Name Type Description
dto System.Dynamic.ExpandoObject The dynamic DTO.
Generic Types
Name Description
T The type of object.

ToDto(data) method

Summary

Converts an object to a dynamic DTO.

Returns

The dynamic DTO.

Parameters
Name Type Description
data System.Object The object to convert.

ToDto``1(data,dto) method

Summary

Converts an object to a specified type of DTO.

Returns

The populated DTO.

Parameters
Name Type Description
data System.Object The object to convert.
dto ``0 The DTO instance to populate.
Generic Types
Name Description
T The type of DTO.

ToDto``1(data) method

Summary

Converts an object to a new instance of a specified type of DTO.

Returns

The new instance of the DTO.

Parameters
Name Type Description
data System.Object The object to convert.
Generic Types
Name Description
T The type of DTO.

DynDtoNameAttribute type

Namespace

CuteUtils.Reflection

Summary

Represents an attribute that specifies the dynamic DTO name for a property.

Parameters
Name Type Description
name T:CuteUtils.Reflection.DynDtoNameAttribute The dynamic DTO name.
Remarks

Initializes a new instance of the DynDtoNameAttribute class with the specified name.

#ctor(name) constructor

Summary

Represents an attribute that specifies the dynamic DTO name for a property.

Parameters
Name Type Description
name System.String The dynamic DTO name.
Remarks

Initializes a new instance of the DynDtoNameAttribute class with the specified name.

Name property

Summary

Gets or sets the dynamic DTO name.

Ellipse type

Namespace

CuteUtils.FluentMath.Shapes

Summary

Represents an ellipse shape.

Parameters
Name Type Description
majorAxis T:CuteUtils.FluentMath.Shapes.Ellipse The length of the major axis.
Remarks

Initializes a new instance of the Ellipse class with the specified major and minor axes.

#ctor(majorAxis,minorAxis) constructor

Summary

Represents an ellipse shape.

Parameters
Name Type Description
majorAxis System.Double The length of the major axis.
minorAxis System.Double The length of the minor axis.
Remarks

Initializes a new instance of the Ellipse class with the specified major and minor axes.

Area property

Summary

Gets the area of the ellipse.

Circumference property

Summary

Gets the circumference of the ellipse.

IsCircle property

Summary

Gets a value indicating whether the ellipse is a circle.

MajorAxis property

Summary

Gets or sets the length of the major axis.

MinorAxis property

Summary

Gets or sets the length of the minor axis.

FormatConfig type

Namespace

CuteUtils.Logging

Summary

Format configuration.

ConsoleFormat property

Summary

The format for the console.

DebugConsoleFormat property

Summary

The format for the debug console.

FileFormat property

Summary

The format for the log file.

Int16Fluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

IntegerFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Int16
value System.Int16

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Int16
value System.Int16

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Int16
value System.Int16

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Int16
value System.Int16

ToDecimal(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Int16

ToDouble(num) method

Summary

Converts number to Double

Returns

Number as Double

Parameters
Name Type Description
num System.Int16

ToInt32(num) method

Summary

Converts number to Int32

Returns

Number as Int32

Parameters
Name Type Description
num System.Int16

ToInt64(num) method

Summary

Converts number to Int64

Returns

Number as Int64

Parameters
Name Type Description
num System.Int16

ToSingle(num) method

Summary

Converts number to Single

Returns

Number as Single

Parameters
Name Type Description
num System.Int16

Int32Fluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

IntegerFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Int32
value System.Int32

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Int32
value System.Int32

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Int32
value System.Int32

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Int32
value System.Int32

ToDecimal(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Int32

ToDouble(num) method

Summary

Converts number to Double

Returns

Number as Double

Parameters
Name Type Description
num System.Int32

ToInt16(num) method

Summary

Converts number to Int16

Returns

Number as Int16

Parameters
Name Type Description
num System.Int32

ToInt64(num) method

Summary

Converts number to Int64

Returns

Number as Int64

Parameters
Name Type Description
num System.Int32

ToSingle(num) method

Summary

Converts number to Single

Returns

Number as Single

Parameters
Name Type Description
num System.Int32

Int64Fluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

IntegerFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Int64
value System.Int64

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Int64
value System.Int64

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Int64
value System.Int64

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Int64
value System.Int64

ToDecimal(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Int64

ToDouble(num) method

Summary

Converts number to Double

Returns

Number as Double

Parameters
Name Type Description
num System.Int64

ToInt16(num) method

Summary

Converts number to Int16

Returns

Number as Int16

Parameters
Name Type Description
num System.Int64

ToInt32(num) method

Summary

Converts number to Int32

Returns

Number as Int32

Parameters
Name Type Description
num System.Int64

ToSingle(num) method

Summary

Converts number to Single

Returns

Number as Single

Parameters
Name Type Description
num System.Int64

LogConfig type

Namespace

CuteUtils.Logging

Summary

Logging configuration.

DebugConfig property

Summary

The configuration for Debug messages.

ErrorConfig property

Summary

The configuration for Error messages.

FatalConfig property

Summary

The configuration for Fatal messages.

FormatConfig property

Summary

The configuration for the message format.

InfoConfig property

Summary

The configuration for Info messages.

WarnConfig property

Summary

The configuration for Warn messages.

LogFormatBuilder type

Namespace

CuteUtils.Logging

Summary

A builder for FormatConfig

#ctor() constructor

Summary

Creates a new LogFormatBuilder instance.

Parameters

This constructor has no parameters.

#ctor(value) constructor

Summary

Creates a new LogFormatBuilder instance.

Parameters
Name Type Description
value System.String The inital format.

DateTime(format,padding) method

Summary

Appends the log datie time to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

FilePath(format,padding) method

Summary

Appends the file path to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

LineNumber(format,padding) method

Summary

Appends the line number to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

LogSeverity(format,padding) method

Summary

Appends the log severity to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

MemberName(format,padding) method

Summary

Appends the log source to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

Message(format,padding) method

Summary

Appends the log message to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

Source(format,padding) method

Summary

Appends the log source to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
format System.String The format to apply.
padding System.Int32 The padding to apply.

Text(value) method

Summary

Appends text to the log format.

Returns

A reference to this LogFormatBuilder instance.

Parameters
Name Type Description
value System.String The text to append.

op_Implicit(value) method

Summary

Converts the LogFormatBuilder to String

Parameters
Name Type Description
value CuteUtils.Logging.LogFormatBuilder)~System.String The LogFormatBuilder to convert.

op_Implicit(value) method

Summary

Converts the String to LogFormatBuilder

Parameters
Name Type Description
value System.String)~CuteUtils.Logging.LogFormatBuilder~CuteUtils.Logging.LogFormatBuilder 'System.String)~CuteUtils.Logging.LogFormatBuilder') The stringBuilder to convert.

LogFormatType type

Namespace

CuteUtils.Logging

Summary

Specifies the info type of the log message format.

DateTime constants

Summary

The DateTime of the log message.

FilePath constants

Summary

The file path of the log message.

LineNumber constants

Summary

The line number of the log message.

LogSeverity constants

Summary

The LogSeverity of the log message.

MemberName constants

Summary

The member name of the log message.

Message constants

Summary

The message of the log message.

Source constants

Summary

The source of the log message.

LogSeverity type

Namespace

CuteUtils.Logging

Summary

Specifies the severity of the log message.

Debug constants

Summary

Logs that contain the most detailed messages.

Error constants

Summary

Logs that highlight when the flow of execution is stopped due to a failure.

Fatal constants

Summary

Logs that contain the most severe level of error. This type of error indicate that immediate attention may be required.

Info constants

Summary

Logs that track the general flow of the application.

Warn constants

Summary

Logs that highlight an abnormal activity in the flow of execution.

LogTarget type

Namespace

CuteUtils.Logging

Summary

Specifies the target of the log message.

Console constants

Summary

Writes log to console

DebugConsole constants

Summary

Writes log to debug console

File constants

Summary

Writes log to file

Logger type

Namespace

CuteUtils.Logging

Summary

Class used for logging

Config property

Summary

Gets or sets the log configuration.

ClearLogFile(logSeverity) method

Summary

Clears the log file for the specified log severity.

Parameters
Name Type Description
logSeverity CuteUtils.Logging.LogSeverity The severity level of the log messages to clear.

Log(message,source,logSeverity,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a message with the specified source, log severity, and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
logSeverity CuteUtils.Logging.LogSeverity The severity level of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

Log(message,logSeverity,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a message with the specified log severity and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
logSeverity CuteUtils.Logging.LogSeverity The severity level of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogDebug(message,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a debug message with additional caller information.

Parameters
Name Type Description
message System.String The message to log.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogDebug(message,source,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a debug message with the specified source and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogError(message,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs an error message with additional caller information.

Parameters
Name Type Description
message System.String The message to log.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogError(message,source,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs an error message with the specified source and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogFatal(message,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a fatal error message with additional caller information.

Parameters
Name Type Description
message System.String The message to log.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogFatal(message,source,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a fatal error message with the specified source and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogIf(condition,message,source,logSeverity,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a message with the specified source, log severity, and additional caller information if the condition is met.

Parameters
Name Type Description
condition System.Boolean The condition to check.
message System.String The message to log.
source System.String The source of the log message.
logSeverity CuteUtils.Logging.LogSeverity The severity level of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogIf(condition,message,logSeverity,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a message with the specified log severity and additional caller information if the condition is met.

Parameters
Name Type Description
condition System.Boolean The condition to check.
message System.String The message to log.
logSeverity CuteUtils.Logging.LogSeverity The severity level of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogInfo(message,source,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs an informational message with the specified source and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogInfo(message,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs an informational message with additional caller information.

Parameters
Name Type Description
message System.String The message to log.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogWarn(message,source,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a warning message with the specified source and additional caller information.

Parameters
Name Type Description
message System.String The message to log.
source System.String The source of the log message.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

LogWarn(message,memberName,sourceFilePath,sourceLineNumber) method

Summary

Logs a warning message with additional caller information.

Parameters
Name Type Description
message System.String The message to log.
memberName System.String The name of the calling member.
sourceFilePath System.String The path of the source file.
sourceLineNumber System.Int32 The line number in the source file.

OutputConfig type

Namespace

CuteUtils.Logging

Summary

Output configuration.

ConsoleColor property

Summary

The console color of the log message.

FilePath property

Summary

The log file path.

LogTarget property

Summary

The target for the log message.

RandomExt type

Namespace

CuteUtils.Misc

Summary

Random Extensions

NextBool(random) method

Summary

Returns a random boolean value.

Returns

A random boolean value.

Parameters
Name Type Description
random System.Random The random number generator.

NextEnum``1(random) method

Summary

Returns a random value from the specified enum type.

Returns

A random value from the enum type.

Parameters
Name Type Description
random System.Random The random number generator.
Generic Types
Name Description
T The enum type.

NextEnum``1(random,values) method

Summary

Returns a random value from the specified array of enum values.

Returns

A random value from the array of enum values.

Parameters
Name Type Description
random System.Random The random number generator.
values ``0[] The array of enum values.
Generic Types
Name Description
T The enum type.

NextItem``1(random,enumerable) method

Summary

Returns a random item from the specified enumerable.

Returns

A random item from the enumerable.

Parameters
Name Type Description
random System.Random The random number generator.
enumerable System.Collections.Generic.IEnumerable{``0} The enumerable to select a random item from.
Generic Types
Name Description
T The type of the items in the enumerable.

Rectangle type

Namespace

CuteUtils.FluentMath.Shapes

Summary

Represents a rectangle shape.

Parameters
Name Type Description
length T:CuteUtils.FluentMath.Shapes.Rectangle The length of the rectangle.
Remarks

Initializes a new instance of the Rectangle class with the specified length and width.

#ctor(length,width) constructor

Summary

Represents a rectangle shape.

Parameters
Name Type Description
length System.Double The length of the rectangle.
width System.Double The width of the rectangle.
Remarks

Initializes a new instance of the Rectangle class with the specified length and width.

Area property

Summary

Gets the area of the rectangle.

Diagonal property

Summary

Gets the diagonal length of the rectangle.

IsGolden property

Summary

Gets a value indicating whether the rectangle has a golden ratio.

IsRectangle property

Summary

Gets a value indicating whether the rectangle is a rectangle (not a square).

IsSquare property

Summary

Gets a value indicating whether the rectangle is a square.

Length property

Summary

Gets or sets the length of the rectangle.

Perimeter property

Summary

Gets the perimeter of the rectangle.

Width property

Summary

Gets or sets the width of the rectangle.

ReflectionExtentions type

Namespace

CuteUtils.Reflection

Summary

Provides extension methods for reflection operations.

CopyProperties``1(obj) method

Summary

Creates a new instance of the specified type and copies the properties from the source object to the new instance.

Returns

A new instance of the specified type with copied properties.

Parameters
Name Type Description
obj System.Object The source object.
Generic Types
Name Description
T The type of the new instance.

CopyProperties``1(obj,newObj) method

Summary

Copies the properties from the source object to the specified target object.

Returns

The target object with copied properties.

Parameters
Name Type Description
obj System.Object The source object.
newObj ``0 The target object.
Generic Types
Name Description
T The type of the target object.
Exceptions
Name Description
System.ArgumentNullException Thrown when the target object is null.

SingleFluent type

Namespace

CuteUtils.FluentMath.TypeExtentions

Summary

FloatFluent class

Abs() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Acos() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Acosh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Add(num,value) method

Summary

Adds the two nums

Returns
Parameters
Name Type Description
num System.Single
value System.Single

Asin() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Asinh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atan() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atan2() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Atanh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cbrt() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Ceiling() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Clamp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cos() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Cosh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Divide(num,value) method

Summary

Divides the two nums

Returns
Parameters
Name Type Description
num System.Single
value System.Single

Exp() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Floor() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

IEEERemainder() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Log10() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Multiply(num,value) method

Summary

Multiples the two nums

Returns
Parameters
Name Type Description
num System.Single
value System.Single

Pow() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Round() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sign() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sin() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sinh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Sqrt() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Subtract(num,value) method

Summary

Subtracts the two nums

Returns
Parameters
Name Type Description
num System.Single
value System.Single

Tan() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Tanh() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

ToDecimal(num) method

Summary

Converts number to Decimal

Returns

Number as Decimal

Parameters
Name Type Description
num System.Single

ToDouble(num) method

Summary

Converts number to Double

Returns

Number as Double

Parameters
Name Type Description
num System.Single

ToInt16(num) method

Summary

Converts number to Int16

Returns

Number as Int16

Parameters
Name Type Description
num System.Single

ToInt32(num) method

Summary

Converts number to Int32

Returns

Number as Int32

Parameters
Name Type Description
num System.Single

ToInt64(num) method

Summary

Converts number to Int64

Returns

Number as Int64

Parameters
Name Type Description
num System.Single

Truncate() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

StringExt type

Namespace

CuteUtils

Summary

String Extensions

CorrectNewLine(str) method

Summary

Uses the correct newline String defined for this environment.

Returns
Parameters
Name Type Description
str System.String

RemoveWhitespaces(str) method

Summary

Removes all white spaces from the specified String

Returns
Parameters
Name Type Description
str System.String

Reverse(str) method

Summary

Reverses the specified String

Returns
Parameters
Name Type Description
str System.String

ToFileName(str,allowSpaces) method

Summary

Removes all invalid chars from the specified String

Returns
Parameters
Name Type Description
str System.String
allowSpaces System.Boolean

ToPath(str,allowSpaces) method

Summary

Removes all invalid chars from the specified String

Returns
Parameters
Name Type Description
str System.String
allowSpaces System.Boolean

Truncate(str,length) method

Summary

Truncates a String to the specified length.

Returns
Parameters
Name Type Description
str System.String
length System.Int32

Truncate(str,length,ellipsis) method

Summary

Truncates a String to the specified length.

Returns
Parameters
Name Type Description
str System.String
length System.Int32
ellipsis System.Boolean

TableStyle type

Namespace

CuteUtils.Misc

Summary

Table Style

Alternative constants

Summary

The alternative representation of the table

Default constants

Summary

The default representation of the table

List constants

Summary

The list representation of the table

Minimum constants

Summary

The minimal representation of the table

TaskQueue type

Namespace

CuteUtils.Tasks

Summary

Represents a queue of tasks that can be enqueued and processed asynchronously.

Dispose() method

Summary

Disposes the task queue and cancels any pending tasks.

Parameters

This method has no parameters.

Dispose() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

Enqueue(function) method

Summary

Enqueues a task that does not return a value.

Returns

An observable that emits the task when it completes.

Parameters
Name Type Description
function System.Action The action representing the task.

Enqueue(task) method

Summary

Enqueues a pre-created task.

Returns

An observable that emits the task when it completes.

Parameters
Name Type Description
task System.Threading.Tasks.Task The task to enqueue.

Enqueue``1(function) method

Summary

Enqueues a task that returns a value.

Returns

An observable that emits the task when it completes.

Parameters
Name Type Description
function System.Func{``0} The function representing the task.
Generic Types
Name Description
T The type of the value returned by the task.

Enqueue``1(task) method

Summary

Enqueues a pre-created task that returns a value.

Returns

An observable that emits the task when it completes.

Parameters
Name Type Description
task System.Threading.Tasks.Task{``0} The task to enqueue.
Generic Types
Name Description
T The type of the value returned by the task.

Triangle type

Namespace

CuteUtils.FluentMath.Shapes

Summary

Represents a triangle with three sides.

Parameters
Name Type Description
sideA T:CuteUtils.FluentMath.Shapes.Triangle The length of side A.
Remarks

Initializes a new instance of the Triangle class with the specified side lengths.

#ctor(sideA,sideB,sideC) constructor

Summary

Represents a triangle with three sides.

Parameters
Name Type Description
sideA System.Double The length of side A.
sideB System.Double The length of side B.
sideC System.Double The length of side C.
Remarks

Initializes a new instance of the Triangle class with the specified side lengths.

Area property

Summary

Gets the area of the triangle.

IsEquilateral property

Summary

Gets a value indicating whether the triangle is equilateral.

IsIsosceles property

Summary

Gets a value indicating whether the triangle is isosceles.

IsRightAngled property

Summary

Gets a value indicating whether the triangle is right-angled.

IsScalene property

Summary

Gets a value indicating whether the triangle is scalene.

Perimeter property

Summary

Gets the perimeter of the triangle.

SideA property

Summary

Gets or sets the length of side A.

SideB property

Summary

Gets or sets the length of side B.

SideC property

Summary

Gets or sets the length of side C.