M

LoadBase.IsValidReference

Description:
Indicates if the provided reference can host a load.

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

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

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

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

Document

doc

The document containing both the host and the load.
Reference

reference

A reference to a analytical element.
LoadType

type

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

isConstrainedOnHost

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

Return Value Boolean True if a load 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