M

BoundaryConditions.IsValidReference

Description:
Checks if the provided reference can host a boundary conditions.

public static bool IsValidReference(
	Document doc,
	Reference reference,
	BoundaryConditionsType type,
	bool isConstrainedOnHost
)

Public Shared Function IsValidReference ( 
	doc As Document,
	reference As Reference,
	type As BoundaryConditionsType,
	isConstrainedOnHost As Boolean
) As Boolean

public:
static bool IsValidReference(
	Document^ doc, 
	Reference^ reference, 
	BoundaryConditionsType type, 
	bool isConstrainedOnHost
)

static member IsValidReference : 
        doc : Document * 
        reference : Reference * 
        type : BoundaryConditionsType * 
        isConstrainedOnHost : bool -> bool

Document

doc

The document containing both the host and the boundary conditions.
Reference

reference

A reference to an analytical element.
BoundaryConditionsType

type

The type of the boundary conditions that is about to be hosted.
Boolean

isConstrainedOnHost

A value indicating if the boundary conditions is constrained on host or not.

Return Value Boolean True if a boundary conditions can be placed on the input host.

ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration