Class CsRecord

Data model that represents a record implementation.

Inheritance
object
CsModel
CsContainer
CsRecord
Implements
Inherited Members
Namespace: CodeFactory.DotNet.CSharp
Assembly: CodeFactory.DotNet.dll
Syntax
public abstract class CsRecord : CsContainer, ICsRecord, ICsContainer, ICsModel, ICsAttributes, ICsGeneric, IParent, IDotNetRecord, IDotNetContainer, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IDotNetGeneric, IParent, ILookup

Constructors

| Improve this Doc View Source

CsRecord(bool, bool, bool, SourceCodeType, IReadOnlyList<CsAttribute>, bool, bool, IReadOnlyList<CsGenericParameter>, IReadOnlyList<CsType>, string, IReadOnlyList<string>, bool, string, string, string, string, string, CsSecurity, IReadOnlyList<CsInterface>, IReadOnlyList<CsMember>, bool, bool, bool, CsRecord, string, ModelStore<ICsModel>, IReadOnlyList<ModelLoadException>)

Constructor for the CsRecord

Declaration
protected CsRecord(bool isLoaded, bool hasErrors, bool loadedFromSource, SourceCodeType language, IReadOnlyList<CsAttribute> attributes, bool isGeneric, bool hasStrongTypesInGenerics, IReadOnlyList<CsGenericParameter> genericParameters, IReadOnlyList<CsType> genericTypes, string modelSourceFile, IReadOnlyList<string> sourceFiles, bool hasDocumentation, string documentation, string lookupPath, string name, string ns, string parentPath, CsSecurity security, IReadOnlyList<CsInterface> inheritedInterfaces, IReadOnlyList<CsMember> members, bool isStatic, bool isAbstract, bool isSealed, CsRecord baseRecord, string sourceDocument = null, ModelStore<ICsModel> modelStore = null, IReadOnlyList<ModelLoadException> modelErrors = null)
Parameters
Type Name Description
bool isLoaded

Flag that determines if the model was loaded.
bool hasErrors

Flag that determine if errors were found creating the model.
bool loadedFromSource

Flag that determines if the model was loaded from source code or from an existing library.
SourceCodeType language

The target language the model was generated from.
IReadOnlyList<CsAttribute> attributes

List of the attributes assigned to this model.
bool isGeneric

Flag that determines if the container is a generic definition.
bool hasStrongTypesInGenerics

Flag that determines if the generics use strong type definitions.
IReadOnlyList<CsGenericParameter> genericParameters

Generic parameters assigned to the container.
IReadOnlyList<CsType> genericTypes

Target types for the generic parameters assigned to the container.
string modelSourceFile

The source code file the model was generated from.
IReadOnlyList<string> sourceFiles

List of the fully qualified paths to the source code files this model is defined in.
bool hasDocumentation

Flag that determines if the model has XML documentation assigned to it.
string documentation

The xml documentation assigned to the model.
string lookupPath

The fully qualified model lookup path for this model.
string name

The name of the model.
string ns

The namespace the container belongs to.
string parentPath

The fully qualified lookup path for the parent model to this one.
CsSecurity security

The security scope assigned to this model.
IReadOnlyList<CsInterface> inheritedInterfaces

The interfaces that are inherited by this container.
IReadOnlyList<CsMember> members

The members assigned to this container.
bool isStatic

Flag that determines if the model is static.
bool isAbstract

Flag that determines if the model is abstract.
bool isSealed

Flag that determines if the model is sealed.
CsRecord baseRecord

The record model that is base record of this record.
string sourceDocument

The source document that was used to build this model. This is optional parameter and can be null.
ModelStore<ICsModel> modelStore

Optional the lookup storage for models created during the compile or lookup of the model.
IReadOnlyList<ModelLoadException> modelErrors

Optional the error that occurred while creating the model.

Properties

| Improve this Doc View Source

BaseRecord

The base record assigned to this record. This will be null if HasBase is false.

Declaration
public CsRecord BaseRecord { get; }
Property Value
Type Description
CsRecord
| Improve this Doc View Source

Constructors

List of the constructors implemented in this record.

Declaration
public IReadOnlyList<CsMethod> Constructors { get; }
Property Value
Type Description
IReadOnlyList<CsMethod>
| Improve this Doc View Source

Destructor

The destructor implemented in this record.

Declaration
public CsMethod Destructor { get; }
Property Value
Type Description
CsMethod
| Improve this Doc View Source

Fields

List of the fields implemented in this record.

Declaration
public IReadOnlyList<CsField> Fields { get; }
Property Value
Type Description
IReadOnlyList<CsField>
| Improve this Doc View Source

IsAbstract

Flat that determines if this is an abstract record.

Declaration
public bool IsAbstract { get; }
Property Value
Type Description
bool
| Improve this Doc View Source

IsSealed

Flag that determines if this record has been sealed.

Declaration
public bool IsSealed { get; }
Property Value
Type Description
bool
| Improve this Doc View Source

IsStatic

Flag that determines if this record is static.

Declaration
public bool IsStatic { get; }
Property Value
Type Description
bool

Explicit Interface Implementations

| Improve this Doc View Source

IDotNetRecord.BaseRecord

The base record assigned to this record. This will be null if HasBase is false.

Declaration
IDotNetRecord IDotNetRecord.BaseRecord { get; }
Returns
Type Description
IDotNetRecord
| Improve this Doc View Source

IDotNetRecord.Constructors

List of the constructors implemented in this record.

Declaration
IReadOnlyList<IDotNetMethod> IDotNetRecord.Constructors { get; }
Returns
Type Description
IReadOnlyList<IDotNetMethod>
| Improve this Doc View Source

IDotNetRecord.Destructor

The destructor implemented in this record.

Declaration
IDotNetMethod IDotNetRecord.Destructor { get; }
Returns
Type Description
IDotNetMethod
| Improve this Doc View Source

IDotNetRecord.Fields

List of the fields implemented in this record.

Declaration
IReadOnlyList<IDotNetField> IDotNetRecord.Fields { get; }
Returns
Type Description
IReadOnlyList<IDotNetField>

Implements

ICsRecord
ICsContainer
ICsModel
ICsAttributes
ICsGeneric
IParent
IDotNetRecord
IDotNetContainer
IDotNetModel
IModelStatus
ISourceFiles
IDotNetAttributes
IDocumentation
IDotNetGeneric
IParent
ILookup

Extension Methods

CsContainerExtensions.FormatCSharpComparisonMembers(CsContainer, MemberComparisonType)
CSharpModelExtensions.ToModel<T>(CsModel)
DocumentationExtensions.CSharpFormatXmlDocumentationEnumerator(IDocumentation)
DotNetContainerExtensions.FormatCSharpComparisonMembers(IDotNetContainer, MemberComparisonType)