Oasys.D3PLOT.Include class¶

Constants¶

Directory separators¶

Include.NATIVE¶

Use directory separators native to this machine when writing directory names

Include.UNIX¶

Use unix directory separators when writing directory names

Include.WINDOWS¶

Use windows directory separators when writing directory names

Properties¶

property Include.label: integer¶

The label for the include file

property Include.name: string¶

The name for the include file

property Include.parent: integer¶

The label for the include file parent (0 if main file)

Static methods¶

classmethod Include.First(model)¶
Returns the first include file in the model (or None if there are no include files in the model)

Parameters:

model (Model) – Model to get first include file in

Returns:

Include object

Return type:

Include

Example

To get the first include file in model m:
i = Oasys.D3PLOT.Include.First(m)
classmethod Include.GetFromID(model, number)¶
Returns the include file in the model with number (or None if it does not exist)

Parameters:

model (Model) – Model to get include file in

number (integer) – The number for the include file in the model. Note that include file numbers start at 1. 0 is the main file

Returns:

Include object

Return type:

Include

Example

To get include file number 5 in model m:
i = Oasys.D3PLOT.Include.GetFromID(m, 5)
classmethod Include.Last(model)¶
Returns the last include file in the model (or None if there are no include files in the model)

Parameters:

model (Model) – Model to get last include file in

Returns:

Include object

Return type:

Include

Example

To get the last include file in model m:
i = Oasys.D3PLOT.Include.Last(m)
classmethod Include.Total(model)¶
Returns the total number of include files in the model

Parameters:

model (Model) – Model to get total in

Returns:

Number of includes

Return type:

int

Example

To get the number of include files in model m:
t = Oasys.D3PLOT.Include.Total(m)

Instance methods¶

Include.Next()¶
Returns the next include file in the model (or None if there is not one)

Returns:

Include object

Return type:

Include

Example

To get the next include file after include i:
i = i.Next()
Include.Previous()¶
Returns the previous include file in the model (or None if there is not one)

Returns:

Include object

Return type:

Include

Example

To get the previous include file before include i:
i = i.Previous()