Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
StepData_Field Class Reference

Defines a generally defined Field for STEP data : can be used
either in any kind of entity to implement it or in free format
entities in a "late-binding" mode
A field can have : no value (or derived), a single value of
any kind, a list of value : single or double list

When a field is set, this defines its new kind (Integer etc..)
A single value is immediately set. A list of value is, firstly
declared as for a kind (Integer String etc), then declared as
a list with its initial size, after this its items are set
Also it can be set in once if the HArray is ready

#include <StepData_Field.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC StepData_Field ()
 Creates a Field, empty ("no value defined")

 StepData_Field (const StepData_Field &other, const Standard_Boolean copy=Standard_False)
 Creates a Field from another one. If <copy> is True, Handled
data (Select,String,List, not entities) are copied

void CopyFrom (const StepData_Field &other)
 Gets the copy of the values of another field

void Clear (const Standard_Integer kind=0)
 Clears the field, to set it as "no value defined"
Just before SetList, predeclares it as "any"
A Kind can be directly set here to declare a type

void SetDerived ()
 Codes a Field as derived (no proper value)

void SetInt (const Standard_Integer val)
 Directly sets the Integer value, if its Kind matches
Integer, Boolean, Logical, or Enum (does not change Kind)

void SetInteger (const Standard_Integer val=0)
 Sets an Integer value (before SetList* declares it as Integer)

void SetBoolean (const Standard_Boolean val=Standard_False)
 Sets a Boolean value (or predeclares a list as boolean)

void SetLogical (const StepData_Logical val=StepData_LFalse)
 Sets a Logical Value (or predeclares a list as logical)

void SetReal (const Standard_Real val=0.0)
 Sets a Real Value (or predeclares a list as Real);

void SetString (const Standard_CString val="")
 Sets a String Value (or predeclares a list as String)
Does not redefine the Kind if it is alread String or Enum

void SetEnum (const Standard_Integer val=-1, const Standard_CString text="")
 Sets an Enum Value (as its integer counterpart)
(or predeclares a list as Enum)
If <text> is given , also sets its textual expression
<val> negative means unknown (known values begin at 0)

void SetSelectMember (const Handle< StepData_SelectMember > &val)
 Sets a SelectMember (for Integer,Boolean,Enum,Real,Logical)
Hence, the value of the field is accessed through this member

void SetEntity (const Handle< Standard_Transient > &val)
 Sets an Entity Value

void SetEntity ()
 Predeclares a list as of entity

void SetList (const Standard_Integer size, const Standard_Integer first=1)
 Declares a field as a list, with an initial size
Initial lower is defaulted as 1, can be defined
The list starts empty, typed by the last Set*
If no Set* before, sets it as "any" (transient/select)

void SetList2 (const Standard_Integer siz1, const Standard_Integer siz2, const Standard_Integer f1=1, const Standard_Integer f2=1)
 Declares a field as an homogeneous square list, with initial\
sizes, and initial lowers

void Set (const Handle< Standard_Transient > &val)
 Sets an undetermined value : can be String, SelectMember,
HArray(1-2) ... else, an Entity
In case of an HArray, determines and records its size(s)

void ClearItem (const Standard_Integer num)
 Declares an item of the list as undefined
(ignored if list not defined as String,Entity or Any)

void SetInt (const Standard_Integer num, const Standard_Integer val, const Standard_Integer kind)
 Internal access to an Integer Value for a list, plus its kind

void SetInteger (const Standard_Integer num, const Standard_Integer val)
 Sets an Integer Value for a list (rank num)
(recognizes a SelectMember)

void SetBoolean (const Standard_Integer num, const Standard_Boolean val)
void SetLogical (const Standard_Integer num, const StepData_Logical val)
void SetEnum (const Standard_Integer num, const Standard_Integer val, const Standard_CString text="")
 Sets an Enum Value (Integer counterpart), also its text
expression if known (if list has been set as "any")

void SetReal (const Standard_Integer num, const Standard_Real val)
void SetString (const Standard_Integer num, const Standard_CString val)
void SetEntity (const Standard_Integer num, const Handle< Standard_Transient > &val)
Standard_Boolean IsSet (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_Integer ItemKind (const Standard_Integer n1=1, const Standard_Integer n2=1) const
 Returns the kind of an item in a list or double list
It is the kind of the list, except if it is "Any", in such a
case the true kind is determined and returned

Standard_Integer Kind (const Standard_Boolean type=Standard_True) const
 Returns the kind of the field
<type> True (D) : returns only the type itself
else, returns the complete kind

Standard_Integer Arity () const
Standard_Integer Length (const Standard_Integer index=1) const
Standard_Integer Lower (const Standard_Integer index=1) const
Standard_Integer Int () const
Standard_Integer Integer (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_Boolean Boolean (const Standard_Integer n1=1, const Standard_Integer n2=1) const
StepData_Logical Logical (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_Real Real (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_CString String (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_Integer Enum (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Standard_CString EnumText (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Handle_Standard_Transient Entity (const Standard_Integer n1=1, const Standard_Integer n2=1) const
Handle_Standard_Transient Transient () const

Constructor & Destructor Documentation


Member Function Documentation


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