MeshKit  1.0
IAVariable Class Reference

Class defining a variable for interval assignment. These are the data objects shared between Interval Assignment and the rest of MeshKit. More...

#include <meshkit/IAVariable.hpp>

List of all members.

Public Types

typedef MeshKit::Firmness Firmness
 Get/Set the firmness, the required fidelity of the solution to the goal.
typedef MeshKit::Firmness Firmness
 Get/Set the firmness, the required fidelity of the solution to the goal.
typedef MeshKit::Firmness Firmness
 Get/Set the firmness, the required fidelity of the solution to the goal.

Public Member Functions

void set_model_ent (ModelEnt *me)
 Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.
ModelEntget_model_ent () const
void set_firmness (Firmness set_firm)
Firmness get_firmness () const
void set_hard ()
void set_soft ()
void unset ()
bool is_soft () const
bool is_hard () const
bool is_default () const
void set_goal (double goal_value)
 Get/Set the goal, the number of intervals we'd like this variable to have in the solution.
double get_goal () const
int get_solution () const
 Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.
 IAVariable (ModelEnt *model_entity=NULL, Firmness set_firmness=SOFT, double goal_value=0.)
 Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.
void set_model_ent (ModelEnt *me)
 Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.
ModelEntget_model_ent () const
void set_firmness (Firmness set_firm)
Firmness get_firmness () const
void set_hard ()
void set_soft ()
void unset ()
bool is_soft () const
bool is_hard () const
bool is_default () const
void set_goal (double goal_value)
 Get/Set the goal, the number of intervals we'd like this variable to have in the solution.
double get_goal () const
int get_solution () const
 Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.
 IAVariable (ModelEnt *model_entity=NULL, Firmness set_firmness=SOFT, double goal_value=0.)
 Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.
void set_model_ent (ModelEnt *me)
 Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.
ModelEntget_model_ent () const
void set_firmness (Firmness set_firm)
Firmness get_firmness () const
void set_hard ()
void set_soft ()
void unset ()
bool is_soft () const
bool is_hard () const
bool is_default () const
void set_goal (double goal_value)
 Get/Set the goal, the number of intervals we'd like this variable to have in the solution.
double get_goal () const
int get_solution () const
 Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.
 IAVariable (ModelEnt *model_entity=NULL, Firmness set_firmness=SOFT, double goal_value=0.)
 Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.

Private Attributes

unsigned int uniqueId

Static Private Attributes

static unsigned int numVariables
 IAInterface is friend class to it can set the solution, and use its index.

Friends

class IAInterface

Internal data representation.

Firmness firmness
double goal
 goal should be >=1., non-integer is OK.
int solution
 solution <0 notsolved, >=1 solved
ModelEntmodelEnt
 modelEnt, NULL is OK.

Detailed Description

Class defining a variable for interval assignment. These are the data objects shared between Interval Assignment and the rest of MeshKit.

These should be constructed/destructed by Meshkit through IAInterface, not directly.

Definition at line 25 of file IntervalAssignment/meshkit/IAVariable.hpp.


Member Typedef Documentation

Get/Set the firmness, the required fidelity of the solution to the goal.

Definition at line 41 of file IntervalAssignment/meshkit/IAVariable.hpp.

Get/Set the firmness, the required fidelity of the solution to the goal.

Definition at line 41 of file meshkit/IAVariable.hpp.

Get/Set the firmness, the required fidelity of the solution to the goal.

Definition at line 69 of file IntervalAssignment/stubs/IAVariable.hpp.


Constructor & Destructor Documentation

IAVariable ( ModelEnt model_entity = NULL,
Firmness  set_firmness = SOFT,
double  goal_value = 0. 
) [inline]

Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.

Definition at line 98 of file IntervalAssignment/meshkit/IAVariable.hpp.

IAVariable ( ModelEnt model_entity = NULL,
Firmness  set_firmness = SOFT,
double  goal_value = 0. 
)

Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.

IAVariable ( ModelEnt model_entity = NULL,
Firmness  set_firmness = SOFT,
double  goal_value = 0. 
)

Constructor; mesh entity can be missing. Call IAInterface::create_variable instead; see that for documentation.


Member Function Documentation

Firmness get_firmness ( ) const [inline]

Definition at line 44 of file IntervalAssignment/meshkit/IAVariable.hpp.

Firmness get_firmness ( ) const [inline]

Definition at line 44 of file meshkit/IAVariable.hpp.

Firmness get_firmness ( ) const [inline]

Definition at line 72 of file IntervalAssignment/stubs/IAVariable.hpp.

double get_goal ( ) const [inline]

Definition at line 56 of file meshkit/IAVariable.hpp.

double get_goal ( ) const [inline]

Definition at line 56 of file IntervalAssignment/meshkit/IAVariable.hpp.

double get_goal ( ) const [inline]

Definition at line 84 of file IntervalAssignment/stubs/IAVariable.hpp.

ModelEnt* get_model_ent ( ) const [inline]

Definition at line 36 of file IntervalAssignment/meshkit/IAVariable.hpp.

ModelEnt* get_model_ent ( ) const [inline]

Definition at line 36 of file meshkit/IAVariable.hpp.

ModelEnt* get_model_ent ( ) const [inline]

Definition at line 64 of file IntervalAssignment/stubs/IAVariable.hpp.

int get_solution ( ) const [inline]

Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.

Only interval assignment should be setting the solution, so we leave "set_solution" out of the public interface.

Definition at line 66 of file meshkit/IAVariable.hpp.

int get_solution ( ) const [inline]

Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.

Only interval assignment should be setting the solution, so we leave "set_solution" out of the public interface.

Definition at line 66 of file IntervalAssignment/meshkit/IAVariable.hpp.

int get_solution ( ) const [inline]

Get the solution to the interval assignment problem for this variable. The solution exists if IAInterface::execute_this has been called already and it was successful, and the value returned will be >=1. Otherwise the value returned will be < 1.

Only interval assignment should be setting the solution, so we leave "set_solution" out of the public interface.

Definition at line 94 of file IntervalAssignment/stubs/IAVariable.hpp.

bool is_default ( ) const [inline]

Definition at line 50 of file IntervalAssignment/meshkit/IAVariable.hpp.

bool is_default ( ) const [inline]

Definition at line 50 of file meshkit/IAVariable.hpp.

bool is_default ( ) const [inline]

Definition at line 78 of file IntervalAssignment/stubs/IAVariable.hpp.

bool is_hard ( ) const [inline]

Definition at line 49 of file IntervalAssignment/meshkit/IAVariable.hpp.

bool is_hard ( ) const [inline]

Definition at line 49 of file meshkit/IAVariable.hpp.

bool is_hard ( ) const [inline]

Definition at line 77 of file IntervalAssignment/stubs/IAVariable.hpp.

bool is_soft ( ) const [inline]

Definition at line 48 of file IntervalAssignment/meshkit/IAVariable.hpp.

bool is_soft ( ) const [inline]

Definition at line 48 of file meshkit/IAVariable.hpp.

bool is_soft ( ) const [inline]

Definition at line 76 of file IntervalAssignment/stubs/IAVariable.hpp.

void set_firmness ( Firmness  set_firm) [inline]

Definition at line 43 of file IntervalAssignment/meshkit/IAVariable.hpp.

void set_firmness ( Firmness  set_firm) [inline]

Definition at line 43 of file meshkit/IAVariable.hpp.

void set_firmness ( Firmness  set_firm) [inline]

Definition at line 71 of file IntervalAssignment/stubs/IAVariable.hpp.

void set_goal ( double  goal_value) [inline]

Get/Set the goal, the number of intervals we'd like this variable to have in the solution.

Definition at line 55 of file meshkit/IAVariable.hpp.

void set_goal ( double  goal_value) [inline]

Get/Set the goal, the number of intervals we'd like this variable to have in the solution.

Definition at line 55 of file IntervalAssignment/meshkit/IAVariable.hpp.

void set_goal ( double  goal_value) [inline]

Get/Set the goal, the number of intervals we'd like this variable to have in the solution.

Definition at line 83 of file IntervalAssignment/stubs/IAVariable.hpp.

void set_hard ( ) [inline]

Definition at line 45 of file IntervalAssignment/meshkit/IAVariable.hpp.

void set_hard ( ) [inline]

Definition at line 45 of file meshkit/IAVariable.hpp.

void set_hard ( ) [inline]

Definition at line 73 of file IntervalAssignment/stubs/IAVariable.hpp.

void set_model_ent ( ModelEnt me) [inline]

Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.

Definition at line 35 of file IntervalAssignment/meshkit/IAVariable.hpp.

void set_model_ent ( ModelEnt me) [inline]

Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.

Definition at line 35 of file meshkit/IAVariable.hpp.

void set_model_ent ( ModelEnt me) [inline]

Get/Set the model_entity directly associated with this variable, if any. This makes the most sense for curves. Schemes and Entities may have extra variables beyond or instead of this one, e.g. intervals for holes or sweep levels, "periodic" intervals for through holes, boundary layers, skew control decomposition, bias.

Definition at line 63 of file IntervalAssignment/stubs/IAVariable.hpp.

void set_soft ( ) [inline]

Definition at line 46 of file meshkit/IAVariable.hpp.

void set_soft ( ) [inline]

Definition at line 46 of file IntervalAssignment/meshkit/IAVariable.hpp.

void set_soft ( ) [inline]

Definition at line 74 of file IntervalAssignment/stubs/IAVariable.hpp.

void unset ( ) [inline]

Definition at line 47 of file meshkit/IAVariable.hpp.

void unset ( ) [inline]

Definition at line 47 of file IntervalAssignment/meshkit/IAVariable.hpp.

void unset ( ) [inline]

Definition at line 75 of file IntervalAssignment/stubs/IAVariable.hpp.


Friends And Related Function Documentation

IAInterface [friend]

Definition at line 94 of file IntervalAssignment/meshkit/IAVariable.hpp.


Member Data Documentation

Firmness firmness [private]

Definition at line 78 of file IntervalAssignment/meshkit/IAVariable.hpp.

double goal [private]

goal should be >=1., non-integer is OK.

Definition at line 81 of file IntervalAssignment/meshkit/IAVariable.hpp.

ModelEnt * modelEnt [private]

modelEnt, NULL is OK.

Definition at line 87 of file IntervalAssignment/meshkit/IAVariable.hpp.

static unsigned int numVariables [static, private]

IAInterface is friend class to it can set the solution, and use its index.

Definition at line 92 of file IntervalAssignment/meshkit/IAVariable.hpp.

int solution [private]

solution <0 notsolved, >=1 solved

Definition at line 84 of file IntervalAssignment/meshkit/IAVariable.hpp.

unsigned int uniqueId [private]

Definition at line 93 of file IntervalAssignment/meshkit/IAVariable.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines