DesignParameter Class Reference

A definition of data that is logically stored in the Model heirarchy. Data could be a property of a Model, Geometry, Vertex, Shape, or Material. More...

#include <DesignParameter.h>

Collaboration diagram for DesignParameter:

Public Types
enum	SpecialParameter {   e_undefined , e_design_property , e_geometry_property , e_model_property ,   e_vertex_property , e_offset , e_rotation , e_scale ,   e_surface_area , e_volume , e_length , e_grade ,   e_h_length , e_v_length , e_geo_orientation , e_model_index ,   e_vertex_index , e_deployment_bottom , e_parent_path , e_metadata ,   e_transformed_vertex_metadata }

Public Member Functions
TypeInfo	defaultType () const
ConstPointer< Unit >	defaultUnit () const
	DesignParameter ()
	DesignParameter (const String &column_name, uint04 vertex_index_a, uint04 vertex_index_b)
	DesignParameter (const String &name)
	DesignParameter (DesignObject::DesignProperty property, uint04 sub_section=Constant< uint04 >::Invalid)
	DesignParameter (Geometry::GeometryProperty property, uint04 sub_section=Constant< uint04 >::Invalid)
	DesignParameter (Model::ModelProperty property, uint04 sub_section=Constant< uint04 >::Invalid)
	DesignParameter (SpecialParameter property, const String &data_label)
	DesignParameter (SpecialParameter property, const String &data_label, uint04 sub_section)
	DesignParameter (SpecialParameter property, uint04 sub_section=Constant< uint04 >::Invalid)
	DesignParameter (VertexProperty property, uint04 sub_section=Constant< uint04 >::Invalid)
TranslatedString	displayName () const
bool	isIgnored () const
bool	operator!= (const DesignParameter &params) const
bool	operator< (const DesignParameter &params) const
bool	operator== (const DesignParameter &params) const
bool	operator> (const DesignParameter &params) const
void	setCustomDisplayName (const TranslatedString &custom_display_name)
String	stringID () const

Public Attributes
String	column_name
TranslatedString	custom_display_name
String	default_value
uint04	dim_a = Constant<uint04>::Invalid
uint04	dim_b = Constant<uint04>::Invalid
SpecialParameter	special_parameter
ConstPointer< Unit >	unit

Protected Member Functions
void	autoSetSpecialParameter ()

Detailed Description

A definition of data that is logically stored in the Model heirarchy. Data could be a property of a Model, Geometry, Vertex, Shape, or Material.

---

Member Enumeration Documentation

SpecialParameter

enum SpecialParameter

Enumerator
e_undefined
e_design_property
e_geometry_property
e_model_property
e_vertex_property
e_offset
e_rotation
e_scale
e_surface_area
e_volume
e_length
e_grade
e_h_length
e_v_length
e_geo_orientation
e_model_index
e_vertex_index
e_deployment_bottom
e_parent_path
e_metadata
e_transformed_vertex_metadata

Constructor & Destructor Documentation

DesignParameter() [1/10]

DesignParameter

(

)

DesignParameter() [2/10]

DesignParameter ( DesignObject::DesignProperty property, uint04 sub_section = Constant< uint04 >::Invalid )

explicit

DesignParameter() [3/10]

DesignParameter ( Geometry::GeometryProperty property, uint04 sub_section = Constant< uint04 >::Invalid )

explicit

DesignParameter() [4/10]

DesignParameter ( Model::ModelProperty property, uint04 sub_section = Constant< uint04 >::Invalid )

explicit

DesignParameter() [5/10]

DesignParameter ( VertexProperty property, uint04 sub_section = Constant< uint04 >::Invalid )

explicit

DesignParameter() [6/10]

DesignParameter ( SpecialParameter property, uint04 sub_section = Constant< uint04 >::Invalid )

explicit

DesignParameter() [7/10]

DesignParameter	(	SpecialParameter	property,
		const String &	data_label )

DesignParameter() [8/10]

DesignParameter	(	SpecialParameter	property,
		const String &	data_label,
		uint04	sub_section )

DesignParameter() [9/10]

DesignParameter ( const String & name )

explicit

DesignParameter() [10/10]

DesignParameter	(	const String &	column_name,
		uint04	vertex_index_a,
		uint04	vertex_index_b )

Member Function Documentation

autoSetSpecialParameter()

void autoSetSpecialParameter ( )

protected

defaultType()

TypeInfo defaultType

(

)

const

defaultUnit()

ConstPointer< Unit > defaultUnit

(

)

const

displayName()

TranslatedString displayName

(

)

const

isIgnored()

bool isIgnored

(

)

const

operator!=()

bool operator!=

(

const DesignParameter &

params

)

const

operator<()

bool operator<

(

const DesignParameter &

params

)

const

operator==()

bool operator==

(

const DesignParameter &

params

)

const

operator>()

bool operator>

(

const DesignParameter &

params

)

const

setCustomDisplayName()

void setCustomDisplayName

(

const TranslatedString &

custom_display_name

)

stringID()

String stringID

(

)

const

Member Data Documentation

column_name

String column_name

custom_display_name

TranslatedString custom_display_name

default_value

String default_value

dim_a

uint04 dim_a = Constant<uint04>::Invalid

dim_b

uint04 dim_b = Constant<uint04>::Invalid

special_parameter

SpecialParameter special_parameter

unit

ConstPointer<Unit> unit

---

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

• Design/Headers/DesignParameter.h