Public Member Functions | Static Public Member Functions | List of all members
IParseParameterExpressionContext Struct Referenceabstract

Interface adopted by an object which serves as the context for parsing parameter expressions. More...

#include <ParametricModeling.h>

Inheritance diagram for IParseParameterExpressionContext:
IParameterExpressionContext RefCountedBase RefCounted< IRefCounted > IRefCounted

Public Member Functions

DGNPLATFORM_EXPORT ParameterType GetResultType () const
 Returns the type to which the expression is expected to resolve. The parser will attempt to coerce the result to this type. More...
 
DGNPLATFORM_EXPORT WCharCP GetTargetAccessString () const
 Returns the access string of the parameter to which the parsed expression is to be assigned, or null if no assignment is specified. More...
 
DistanceParserPtr CreateDistanceParser () const
 Returns an object which can parse a distance. More...
 
AngleParserPtr CreateAngleParser () const
 Returns an object which can parse an angle. More...
 
AreaParserPtr CreateAreaParser () const
 Returns an object which can parse an area. More...
 
- Public Member Functions inherited from IParameterExpressionContext
DGNPLATFORM_EXPORT
IParameterDefinitionsCR 
GetParameterDefinitions () const
 Returns the parameter definitions against which parsing or evaluation is to be performed. More...
 
DGNPLATFORM_EXPORT DgnModelR GetHostModel () const
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Static Public Member Functions

static DGNPLATFORM_EXPORT
IParseParameterExpressionContextPtr 
Create (IParameterDefinitionsCR defs, ParameterType resultType, WCharCP targetAccessString=nullptr)
 
- Static Public Member Functions inherited from IParameterExpressionContext
static DGNPLATFORM_EXPORT
IParameterExpressionContextPtr 
Create (IParameterDefinitionsCR defs)
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

Interface adopted by an object which serves as the context for parsing parameter expressions.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Function Documentation

static DGNPLATFORM_EXPORT IParseParameterExpressionContextPtr Create ( IParameterDefinitionsCR  defs,
ParameterType  resultType,
WCharCP  targetAccessString = nullptr 
)
static
AngleParserPtr CreateAngleParser ( ) const

Returns an object which can parse an angle.

AreaParserPtr CreateAreaParser ( ) const

Returns an object which can parse an area.

DistanceParserPtr CreateDistanceParser ( ) const

Returns an object which can parse a distance.

DGNPLATFORM_EXPORT ParameterType GetResultType ( ) const

Returns the type to which the expression is expected to resolve. The parser will attempt to coerce the result to this type.

DGNPLATFORM_EXPORT WCharCP GetTargetAccessString ( ) const

Returns the access string of the parameter to which the parsed expression is to be assigned, or null if no assignment is specified.


The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.