Class CsStructure
Data model that represents the definition of a structure.
Implements
Inherited Members
Namespace: CodeFactory.DotNet.CSharp
Assembly: CodeFactory.DotNet.dll
Syntax
public abstract class CsStructure : CsContainerWithNestedContainers, ICsNestedModel, IDotNetNestedModel, ICsStructure, ICsNestedContainers, ICsContainer, ICsModel, ICsAttributes, ICsGeneric, IParent, IDotNetStructure, IDotNetNestedContainers, IDotNetContainer, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IDotNetGeneric, IParent, ILookupConstructors
| Improve this Doc View SourceCsStructure(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, IReadOnlyList<ICsNestedModel>, string, ModelStore<ICsModel>, IReadOnlyList<ModelLoadException>)
Constructor for the CsStructure
Declaration
protected CsStructure(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, IReadOnlyList<ICsNestedModel> nestedModels = null, 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 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. |
| 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 SourceConstructors
List of the constructors for this structure.
Declaration
public IReadOnlyList<CsMethod> Constructors { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<CsMethod> |
Fields
List of the fields for this structure.
Declaration
public IReadOnlyList<CsField> Fields { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<CsField> |
Explicit Interface Implementations
| Improve this Doc View SourceIDotNetStructure.Constructors
List of the constructors for this structure.
Declaration
IReadOnlyList<IDotNetMethod> IDotNetStructure.Constructors { get; }Returns
| Type | Description |
|---|---|
| IReadOnlyList<IDotNetMethod> |
IDotNetStructure.Fields
List of the fields for this structure.
Declaration
IReadOnlyList<IDotNetField> IDotNetStructure.Fields { get; }Returns
| Type | Description |
|---|---|
| IReadOnlyList<IDotNetField> |