Class CsClass

Data model that represents a class implementation.

Inheritance
object
CsModel
CsContainer
CsContainerWithNestedContainers
CsClass
Implements
Inherited Members
Namespace: CodeFactory.DotNet.CSharp
Assembly: CodeFactory.DotNet.dll
Syntax
public abstract class CsClass : CsContainerWithNestedContainers, ICsNestedModel, IDotNetNestedModel, ICsClass, ICsNestedContainers, ICsContainer, ICsModel, ICsAttributes, ICsGeneric, IParent, IDotNetClass, IDotNetNestedContainers, IDotNetContainer, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IDotNetGeneric, IParent, ILookup

Constructors

| Improve this Doc View Source

CsClass(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, CsNestedType, bool, bool, bool, CsClass, IReadOnlyList<ICsNestedModel>, string, ModelStore<ICsModel>, IReadOnlyList<ModelLoadException>)

Constructor for the CsClass

Declaration
protected CsClass(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 isNested, CsNestedType nestedType, bool isStatic, bool isAbstract, bool isSealed, CsClass baseClass, IReadOnlyList<ICsNestedModel> nestedModels, 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 isNested

Flag that determines if the container type is nested in another type definition.
CsNestedType nestedType

Enumeration of the type of nesting the container is.
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.
CsClass baseClass

The class model that is base class of this class.
IReadOnlyList<ICsNestedModel> nestedModels

List of nested models assigned to this container. This is an optional parameter and can be null
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

BaseClass

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

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

Constructors

List of the constructors implemented in this class.

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

Destructor

The destructor implemented in this class.

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

Fields

List of the fields implemented in this class.

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 class.

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

IsSealed

Flag that determines if this class has been sealed.

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

IsStatic

Flag that determines if this class is static.

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

Explicit Interface Implementations

| Improve this Doc View Source

IDotNetClass.BaseClass

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

Declaration
IDotNetClass IDotNetClass.BaseClass { get; }
Returns
Type Description
IDotNetClass
| Improve this Doc View Source

IDotNetClass.Constructors

List of the constructors implemented in this class.

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

IDotNetClass.Destructor

The destructor implemented in this class.

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

IDotNetClass.Fields

List of the fields implemented in this class.

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

Implements

ICsNestedModel
IDotNetNestedModel
ICsClass
ICsNestedContainers
ICsContainer
ICsModel
ICsAttributes
ICsGeneric
IParent
IDotNetClass
IDotNetNestedContainers
IDotNetContainer
IDotNetModel
IModelStatus
ISourceFiles
IDotNetAttributes
IDocumentation
IDotNetGeneric
IParent
ILookup

Extension Methods

CsClassExtensions.InheritsBaseClass(CsClass, string, string)
CsContainerExtensions.MissingInterfaceMembers(CsClass)
CsClassExtensions.CSharpFormatBaseTypeName(CsClass, NamespaceManager)
CsClassExtensions.CSharpFormatDeclaration(CsClass, CsSecurity, NamespaceManager, string)
CsContainerExtensions.FormatCSharpComparisonMembers(CsContainer, MemberComparisonType)
CSharpModelExtensions.ToModel<T>(CsModel)
DocumentationExtensions.CSharpFormatXmlDocumentationEnumerator(IDocumentation)
DotNetContainerExtensions.MissingInterfaceMembers(IDotNetClass)
DotNetContainerExtensions.FormatCSharpComparisonMembers(IDotNetContainer, MemberComparisonType)