All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVIAPlugIn Class ENOVPublishObjectNode
ENOVIAPlugIn.ENOVPublishObject
|
+---ENOVPublishObjectNode
Usage: you must use this class as is. You should never derive it.
public class ENOVPublishObjectNode
ENOVIA LCA Objects exposed.
Role:
Tags define on "Object Node" object:
- PrimaryTypeName: The name of object base type.
- SecondaryTypeName: The name of final object type.
- TimeStamp: Date & time of the publishing stream.
- SecondaryTypeOid: the internal id (Oid) of the object type.
- Oid: Object internal Id.
- AccessMode:Access mode.
- Status: Modification status information.
Constructor and Destructor Index
- o
ENOVPublishObjectNode(ENOVPublishObject*,ENOVPublishObjectClass*)
- Constructs a node object.
- o
ENOVPublishObjectNode(ENOVPublishObjectNode&)
- Copy constructor.
- o
~ENOVPublishObjectNode()
-
Method Index
- o
GetOid(unsigned char*&,int&)
- Returns the internal id (Oid) of the object instance.
- o
GetPrimaryType(char*&)
- Returns the name of object base type.
- o
GetSecondaryType(char*&)
- Returns the name of final object type.
- o
GetTimeStamp(char*&)
- Returns date & time of the Object node.
- o
GetTypeId(unsigned char*&,int&)
- Returns the internal id (Oid) of the object type.
- o
Print(int)
- Print a report on standard output.
- o
operator=(ENOVPublishObjectNode&)
- Assignment operator from another object node.
Constructor and Destructor
o ENOVPublishObjectNode
-
Constructs a node object.
- Parameters:
-
- ixFather
- Pointer to the father node for this object.
- ixClass
- Pointer to a class node that could be used as template.
Default values: No value or null means that no template is used.
o ENOVPublishObjectNode
-
Copy constructor.
- Parameters:
-
- ixNode
- Object to be duplicated.
o ~ENOVPublishObjectNode
public virtual ~ENOVPublishObjectNode( | ) |
-
Methods
o GetOid
public int GetOid( | const unsigned char*& | ocOid, |
| int& | onLength)const |
-
Returns the internal id (Oid) of the object instance.
Role: Returns the binary value corresponding internal id (Oid)
of the object instance.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocOid
- Binary string value.
- onLength
- Binary string length.
o GetPrimaryType
public int GetPrimaryType( | const char*& | ocPrimaryType)const |
-
Returns the name of object base type.
Role: Returns the name of object base type, ie the ENOVIA standard object
class that will be customized on site.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocPrimaryType
- Type Name of the base object.
o GetSecondaryType
public int GetSecondaryType( | const char*& | ocSecondaryType)const |
-
Returns the name of final object type.
Role: Returns the name of object type, ie the real name of
ENOVIA object.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocSecondaryType
- Type Name of the object.
o GetTimeStamp
public int GetTimeStamp( | const char*& | ocTimeStamp)const |
-
Returns date & time of the Object node.
Role: Enables to know object timestamp at time information has been
extracted.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocTimeStamp
- Date & time information.
Legal values: Date is expressed using one ISO 8601 format called
Extended format for ordinal date and time of the day (Application will used
Coordinated Universal Time UTC)
CCYY-MM-DDThh:mm:ss | "2000-00-01T00:00:01" |
CCYY-MM-DDThh:mm | "2000-00-01T00:00" |
CCYY-MM-DD | "2000-00-01" No time information set to 00:00:00 |
hh:mm:ss | "12:00:00" means today at noon |
hh:mm | "14:00" means today at 2 pm |
Where:
CC | represents the century component |
YY | represents the year within century |
MM | represents months starting with January [1, 12] |
DD | represents the day in the month [1, 31] |
hh | represents hours from beginning of days |
mm | represents minutes |
ss | represents seconds |
o GetTypeId
public int GetTypeId( | const unsigned char*& | ocSecondaryTypeOid, |
| int& | onLength)const |
-
Returns the internal id (Oid) of the object type.
Role: Returns the binary value corresponding internal id (Oid)
of the object type.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocSecondaryTypeOid
- Binary string value.
- onLength
- Binary string length.
o Print
public virtual void Print( | int | inLevel | = 0 )const |
-
Print a report on standard output.
Role: Print the content of this node and its children.
- Parameters:
-
- inLevel
- Enable to have an indented presentation according to the tree depth of the node.
o operator=
-
Assignment operator from another object node.
- Parameters:
-
- ixNode
- Object used as reference for the assignment.
This object is included in the file: ENOVPublishObjectNode.h
If needed, your Imakefile.mk should include the module: ENOVIAPubStream